Documentation Types
-
Upload
raghunath-gautam-soman -
Category
Documents
-
view
34.619 -
download
3
Transcript of Documentation Types
Documentation TypesDocumentation Types-Gautam Soman
bytespace.blogspot.com
IntroductionIntroductionProject DocumentationTeam DocumentationTest DocumentationSystem DocumentationUser Documentation
bytespace.blogspot.com
Project DocumentationProject DocumentationDescribes the process of creating
productSubmitted to product owner and
approval obtainedLong life-span, relevant
throughout the project life cycleCommon formats: .doc and .pdf
bytespace.blogspot.com
Project DocumentationProject DocumentationProject Proposal DocumentSoftware Requirement
SpecificationsRequirements Understanding
DocumentHigh Level DesignLow Level DesignProject PlanRelease Notes
bytespace.blogspot.com
Team DocumentationTeam DocumentationRefers to communication
between teamShort relevancy and life-spanUsually useful for quick changesE-mail is the most frequently
used mediumCommon formats: .doc, .xls
bytespace.blogspot.com
Team DocumentationTeam DocumentationPlans and SchedulesReview ReportsStatus ReportsMinutes of MeetingsChecklists
bytespace.blogspot.com
Test DocumentationTest DocumentationRefers to documents used in
testing and quality assurance processes
Usually created by QA/QEUsually not shared with end-user,
unless specifically requiredCommon formats: .doc, .xls, .pdf
bytespace.blogspot.com
Test DocumentationTest DocumentationTest PlanTest CasesIssue Logs/ Bug ReportsTest ReportsFactory Acceptance Test
DocumentSite Acceptance Test Document
bytespace.blogspot.com
System DocumentationSystem DocumentationHighly technical in natureUsually created by programmersTools like Sandcastle help in
automationUseful in maintenance, bug fixes and
future enhancements of the productLong life-span, often beyond that of
the projectCommon formats: .doc, .chm,
webhelpbytespace.blogspot.com
System DocumentationSystem DocumentationSource Code DocumentationDatabase DocumentationAPI Documentation
bytespace.blogspot.com
User DocumentationUser DocumentationMost ‘visible’ part of documentationShould be easy-to-understand, yet
preciseNeeds to be revised and kept up-to-
the date to avoid being obsoleteFormats vary
greatly: .doc, .pdf, .chm, webhelpAudio-visual documentation is
catching up
bytespace.blogspot.com
User DocumentationUser DocumentationRead MeInstallation GuideConfiguration GuideQuick Start GuideTraining ManualUser Manual/Online HelpTroubleshooting GuideAdministrator’s Guide
bytespace.blogspot.com
Thank You!Thank You!Find more presentations related
to documentation on my SlideShare page.
Read my blog on technical writing at ByteSpace
Gautam Soman,http://www.gautamsoman.com
bytespace.blogspot.com