Your SlideShare is downloading. ×
What Is Project Documentation
What Is Project Documentation
What Is Project Documentation
What Is Project Documentation
What Is Project Documentation
What Is Project Documentation
What Is Project Documentation
What Is Project Documentation
What Is Project Documentation
What Is Project Documentation
Upcoming SlideShare
Loading in...5
×

Thanks for flagging this SlideShare!

Oops! An error has occurred.

×
Saving this for later? Get the SlideShare app to save on your phone or tablet. Read anywhere, anytime – even offline.
Text the download link to your phone
Standard text messaging rates apply

What Is Project Documentation

17,756

Published on

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

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
17,756
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
196
Comments
1
Likes
1
Embeds 0
No embeds

Report content
Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
No notes for slide

Transcript

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

×