The thorough documentation of an information system's design is vital to its sustainability. Programming code can swiftly become akin to a cryptic crossword, and a professional programmer will always ensure that the clues needed to decipher the code are included within it.

Documentation can exist in a text (printed or onscreen), video or audio format, or any combination thereof. It describes the structure, components and operation of a system, and can include system requirements, design overview, code documentation, online help, FAQs, user guides and marketing.

When writing different types of documentation, the audience / users should be kept in mind, and language should be adjusted accordingly to ensure that it can be easily understood by the relevant people.

Additionally, processes and decisions should be documented fully over the course of managing a project.

Related methods include: General project management and Preservation.

Syndicate content