|
Introduction
|
Software documentation provides both users and developers information about what a software is supposed to do.
Software documentation has numerous benefits including improved team productivity, increased code quality, and better maintainability.
Software documentation can be challenging due to cost and time to maintain.
|
|
Types of Software Documentation
|
There are two primary categories for documentation: developer and user.
Developer documentation is intended to describe how developers should interface with a given software package.
User documentation is intended to help users be more successful in the usage of a software package.
|
|
Documentation Better Practices
|
It is important to be aware of potential unconscious biases when writing documentation. Make sure to consider culture, context, and experience.
No single practice will fit all software projects, but there are some generally better practices: version control, less is more, know your audience, document as you go.
|
|
Documentation in Practice
|
There are numerous examples of different types of documentation in practice, each with its own intended purpose.
A project must pick the documentation that makes the most sense for its use case and domain.
|
|
Documentation Tools
|
|