sentenz / convention

General articles, conventions, and guides.
https://sentenz.github.io/convention/
Apache License 2.0
4 stars 2 forks source link

Create an article about `Software Documentation` #285

Open sentenz opened 12 months ago

sentenz commented 12 months ago

Software Documentation

TODO ChatGPT

Software documentation refers to the comprehensive set of written materials that describe the design, functionality, and use of a software system. It includes various types of documents, such as technical specifications, user guides, and documentation generators, that are necessary to understand, use, and maintain the software.

Category

User Documentation

Technical Documentation

Project Documentation

Testing Documentation

Deployment Documentation

Maintenance Documentation

Regulatory and Compliance Documentation

Knowledge Base

Terminology

References