Document Everything

It is very important to document everything in a project

Documentation

Written text that accompanies a project
Multiplicity of documents
Evolving mix of media collection
- updates (revisions) and expansions

Explains / supports a tool or a process
- how operates
- how to use it
- future maintenance
- enhanced development

"Evergreen document"
- relevant to specific audience over long period of time

Dynamic documents (Living documents)
- document modification guidelines

Rate of document decay
- original document structure
- original document intent

Documenting design

Requirements

Identify system foundation implementations
- attributes
- capabilities
- characteristics
- qualities

Continually edited and updated
Framework for updates, changes, or adjustments

Architecture

Development team overall guidance

Design document
- written view / reference of product
- coordinate group under single vision
- description / outline of all parts

Types:
HLDD : High Level Design Document
LLDD : Low Level Design Document

Technical

Documentation of algorithms
Construction principles used in component design
- Detailed feature specifications

May include writing interfaces
- external or internal set of rules ('codes')
- specifications
— routines
— structures
— object
— classes
— protocols

Data Design Documentation
- structure attributes and relationships between data

Architecture Design Documentation
- Overview relations to environment
- information flow characteristics maps
- transformation mapping boundaries
— incoming data
— outgoing data
- Data Flow module diagrams (control input, processing and output)

Interface Design Documentation
- external program interfaces
- internal program interfaces
- human interface

Procedural Design Documentation
- structured programming concepts
— graphical notations
— tabular notations
— textual notations
- code translation

End User

Manuals
- end-user
- administrators
- support staff

Marketing

Product market
Market demand analysis

Professional fields

Corporate communicators and technical writers
- meets the user's needs

subject matter knowledge (or collaborate with subject matter experts (SMEs))
writing skills (dissertations / treatises / manuals)
managing content skills (information architecture)

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License