THIS TAG IS FOR DOCUMENT GENERATORS ONLY. Include language and/or SDE tag as well. DO NOT USE to ask for links to documentation or tools, or to critique vendor documentation.
Use the documentation tag for questions related to self-documenting code and documentation generators.
Basic definitions
Software documentation is written text or illustration that accompanies computer software or is embedded in the source code. It either explains how it operates or how to use it, and may mean different things to people in different roles.Wikipedia
A documentation generator is a programming tool that generates software documentation intended for programmers or end users, or both, from a set of specially commented source code files, and in some cases, binary files.Wikipedia
Related tags
Possible synonyms:
- document-generation - Synonymous with documentation
- code-documentation - Documentation within code to explain its function and use.
- manual - as in "User's Manual"
Substitute these more specific tags for documentation where possible:
- javadoc - Documentation generation tool for java.
- doxygen - Multi-language documentation generation tool.
- python-sphinx - Tool for python documentation generation, adaptable to other languages.
- jsdoc, jsdoc3 - Documentation generation tools for javascript.
- rd, roxygen2 - Documentation generation tools for r.
- xml-documentation - XML documentation tagging for c#.
- springfox - A suite of java libraries for automating the generation of machine and human readable specifications for JSON APIs written using the spring framework.
- yard - Documentation generation tool for ruby.
- haddock - Documentation generation tool for haskell.
- phpdocumentor2 - Documentation generation tool for php.
- rustdoc - Documentation generation tool for rust.
- kotlin-dokka - Documentation generation tool for
kotlin.
"Documentation" topics on other SE sites
Questions about how documentation fits within the software development process are off-topic on StackOverflow, but are on-topic on Software Engineering.
Writing Stack Exchange has tags for Technical Writing, API Documentation and Software Tools, with a focus on the craft of professional writing.
Useful links
- Getting started? See: Google - How to write user documentation.
- Looking for a tool? See: Wikipedia - Comparison of Documentation Generators.
- Wondering about recommended styles? See: Google - Style guides.
Off-Topic Questions
Remember that the following types of questions are off-topic, and subject to being closed and deleted:
- Where is the documentation for... ?
- What is the best way to document... ?
- Is there a tool to help document... ?
- Is this documentation correct?
