What Is Project Documentation

20,739 views
20,286 views

Published on

An explanation of the different types of documentation involved in a project.

Published in: Education, Technology, Business
1 Comment
1 Like
Statistics
Notes
No Downloads
Views
Total views
20,739
On SlideShare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
230
Comments
1
Likes
1
Embeds 0
No embeds

No notes for slide

What Is Project Documentation

  1. 1. Project Documentation<br />Chris Warren<br />cwarren@williams.edu<br />x4323 Jesup 312<br />
  2. 2. Project Overview<br />requirements<br />understandable by non-technical people<br />specifications<br />explainable to non-technical people<br />defines what you have to do<br />defines when you’re done<br />
  3. 3. Design Documents<br />Internal to the development group<br />Project organization<br />high level plans<br />schedule, work division, etc.<br />Technical aspects / plans<br />how you plan to accomplish your goals<br />
  4. 4. Working Notes<br />internal to the development group<br />milestone, to-do’s, tasks, etc.<br />breadcrumbs<br />issues list<br />ideas list<br />snippets<br />
  5. 5. Sources<br />eventually turned over to sponsor<br />media files<br />raw<br />clean<br />code – ideally in source control<br />current working version<br />work in progress (includes change log)<br />
  6. 6. Final Documentation<br />turned over to sponsor<br />Three main kinds:<br />Developer docs<br />User docs<br />Administrator docs<br />
  7. 7. for Developers<br />for future coders / developers<br />fixing the product<br />extending the product<br />revising the product<br />technical<br />explain thinking / approach<br />
  8. 8. for Users<br />for the people who will be using the product<br />completely non-technical<br />functional oriented<br />FAQ vs. Guide<br />integrated into the product<br />ideally contextually<br />
  9. 9. for Administrators<br />for the non-technical people who will be managing the product (i.e. the sponsor/client)<br />integrated into product, BUT hidden from users<br />step-by-step how-to’s<br />
  10. 10. Where Does It All Go?<br />in the wiki<br />in the project management tool<br />as separate files<br />bundled with the product<br />integrated into the product<br />

×