Documentation Types

Documentation TypesDocumentation Types-Gautam Soman

bytespace.blogspot.com

IntroductionIntroductionProject DocumentationTeam DocumentationTest DocumentationSystem DocumentationUser Documentation

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

Project DocumentationProject DocumentationProject Proposal DocumentSoftware Requirement

SpecificationsRequirements Understanding

DocumentHigh Level DesignLow Level DesignProject PlanRelease Notes

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

Team DocumentationTeam DocumentationPlans and SchedulesReview ReportsStatus ReportsMinutes of MeetingsChecklists

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

Test DocumentationTest DocumentationTest PlanTest CasesIssue Logs/ Bug ReportsTest ReportsFactory Acceptance Test

DocumentSite Acceptance Test Document

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

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

User DocumentationUser DocumentationRead MeInstallation GuideConfiguration GuideQuick Start GuideTraining ManualUser Manual/Online HelpTroubleshooting GuideAdministrator’s Guide

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

Documentation Types

Documents

Transcript of Documentation Types

Characterization Types of documentation - WordPress.com · world. Germplasm movement ... Grapevine, Subtropical, Olive & Citrus). Documentation & Information (Database, Documentation,

Wii U Operations Manual - rinstruct.comrinstruct.com/wp-content/uploads/2015/02/Wii_U_Operations_manual… · Wii U Documentation . . . . . . . . . . . . . . . . 4. Types of Documentation.

Haskell Tutorials Documentation · Haskell Tutorials Documentation, Release 1.0 Note: Strangely, while runQueryconverts DB => Haskell types automagically, runInsertMany and runUpdaterefuse

DNV-RP-A201: Plan Approval Documentation Types – Definitions · 2012-11-15 · PLAN APPROVAL DOCUMENTATION TYPES – DEFINITIONS ... periodical test procedure — New documentation

Audit evidence: types of evidence and working paper documentation

Puppet Documentation - University of Oxfordmohammad/puppet.pdf · Puppet Documentation • Puppet Labs Documentation 2/311. Resource Types — all default types Functions — all

Documentation PostgreSQL 8.3 · 12.9. Types d'index GiST et GIN ..... 220 12.10.

Information Correspondence between Types of Documentation …martin/papers/ese2020.pdf · 2020. 8. 31. · Information Correspondence between Types of Documentation for APIs 3 We

Types of records and common record keeping forms & computerized documentation

MobArena Documentation - media.readthedocs.org · 5 Getting started 15 6 Item and reward syntax 17 7 Leaderboards 21 8 Monster types 23 9 Permissions 25 ... MobArena Documentation,

LPG1.4.03 Policies and Procedures Documentation€¦ · relevant documentation and the passing of information. These student notes explain the types of documentation you will encounter

Facility Sanitation and Documentation - Texas Local Produce€¦ · Facility Sanitation and Documentation . Documentation There are three types of documents you will need for third

Presenter: Karen Fligger, EPA HQ 1. Session Overview CWNS 2012 Documentation Criteria Recap Pre-Approved Document Types Innovative Needs and Costs Documentation.

FINDING AND USING EVIDENCE Types of Evidence The Research Process Documentation.

Data Management: Documentation & Metadata Types of Documentation.

The Types, Roles, and Practices of Documentation in Data Analytics Open ... · The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries A

Django-environ Documentation · 2019-07-16 · Django-environ Documentation, Release 0.4.4 •Fill os.environwith .env ﬁle variables •Variables casting (see Supported types below)

APA Style: In-text documentation and References. Table of Contents In-text Documentation / Definition Three Types of Quotation Common Knowledge In-text.

Matching funds guidance. Matching Funds Guidance F… · Applicant must provide documentation at the time of Application submission. For other types, documentation must be made available

[MS-SSCLRT]: Microsoft SQL Server CLR Types …...[MS-SSCLRT]: Microsoft SQL Server CLR Types Serialization Formats Intellectual Property Rights Notice for Open Specifications Documentation