1 / 17

Project Management Documentation The Problems: Many developers must share information.

Project Management Documentation The Problems: Many developers must share information. New developers must get up to speed quickly. Documentation can be VERY time consuming. Good documentation is a key asset. The Mission:

beggs
Download Presentation

Project Management Documentation The Problems: Many developers must share information.

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Project Management Documentation • The Problems: • Many developers must share information. • New developers must get up to speed quickly. • Documentation can be VERY time consuming. • Good documentation is a key asset. • The Mission: • A student engineer should be able to make edits after 1 day on the job. • Less than 15% of time should be spent on documentation. • Good documentation should increase value of Build-It-Yourself products in the eyes of customers, partners and investors. www.Build-It-Yourself.com

  2. Project Management Documentation Project Plan for I-Scream, open source development tools (1950 estimated hours) www.Build-It-Yourself.com

  3. Project Management Wiki • Discover • Problem and Goals • Target Audience • Research • Set Up Infrastructure • Design • Functional Specs • Technical Specs • Project Plan • Develop • Front End • Back End • Deploy • Test Procedure • Test • Train • Sell Sub-categories may change depending on the development project. www.Build-It-Yourself.com

  4. Project Management Sites Invention Universe (HTML) http://www.build-it-yourself.com/dev/invention-universe/index-iu.html Invention Universe (Wiki) http://www.build-it-yourself.com/dev/invention-universe/index-iu.html UID: john PWD: BIY Build-It-Blocks (HTML) 2000 Hours http://www.build-it-yourself.com/dev/blocks/index.html www.Build-It-Yourself.com

  5. Wiki vs. HTML Pro’s and Con’s • A Wiki is super easy to create, edit and maintain. An HTML page is time consuming to edit and requires an FTP upload. • Search engines cannot find a Wiki page if it’s password protected. It is tricky to set up good password protection for HTML pages. • Several people can edit a Wiki page simultaneously. Only one person can edit an HTML page. If multiple people must edit, then you need to do a complicated staging server source code version protection process. • It is difficult to make a Wiki page look good. HTML has much easier design control. • A Wiki community of editors often will maintain more accurate and updated information than a single HTML editor would. (Witness Encyclopedia Britanica vs. Wikipedia.)

  6. How to build a Wiki project page A simple tutorial of managing your BIY project

  7. Let’s make an example! How do we make a project page for a “remote control robot” project? For information about the remote control robot project, please visit http://build-it-yourself.com/biy-projects/proj-fruit-critters/index-critters.html

  8. Create a blank page There are more than one way to create a new wiki page: 1. (Recommended) Type the url of page you want to create in the address line. For a BIY project, you will type in “http://207.244.118.11/wiki/index.php/Projects/project-name” If there is no page under this address, wiki will take you to blank page. The “edit this page” click will take you to an “edit” page.

  9. Create a blank page 2. Search for the project name, if there is no page under this name, you will be directed to a page with a “to create” option. The “create this page” click will take you to an “edit” page.

  10. Create a blank page *3. When editing another page, you can create an “internal link” to a nonexistent wiki page, with your project name. Save the page you are editing, and click the link you made. The “project name” click will take you to an “edit” page. We will talk about how to create links in your wiki page again later.

  11. Create a blank page This is what an “edit” page looks like.

  12. Set up topic structures You can type in plain text in a wiki edit page. Click “save page” and this is how it looks like. Remember to always save your work!

  13. Set up topic structures To make a list of topics, here are some syntax we will use. “=……=“: Titles; “==……==“: Subtitles; A complete list of titles could look like this:

  14. Set up topic structures Press “save page” and this is how they looks like.

  15. Add content to all the topics Now it’s time to fill in the blanks with information and graphics.

  16. Add content to all the topics And this is how it looks like after you save it.

  17. More on wiki syntax For a full list of syntax in editing a wiki page, check these two pages: http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page http://en.wikipedia.org/wiki/Help:Wiki_markup Thank you very much for reading this tutorial with us. For question or suggestion, please contact John, john@build-it-yourself.com , Brent, bstn32508@gmail.com, or Yuan, yuandong84@yahoo.com.

More Related