Skill: Documenting software

Ability to create clear, concise and comprehensive technical documentation that communicates the design, functionality and usage of a software product.

Related skills

• Information synthesis and concise written communication
• Technical writing

Learning resources

• Datasheets for Datasets - ACM Digital Library
• Diátaxis - Diátaxis
• Model Cards for Model Reporting - Mitchel, M. et al
• OLS Lesson - OLS
• Project Documentation - The Turing Way - The Turing Way

Tools

• cffinit
• CITATION.cff
• Javadoc
• JSDoc
• MkDocs
• Quarto
• R Markdown
• Read the Docs
• Sphynx

Languages

• Markdown

Methodologies

• Code of Conduct
• Contribution guidelines
• Docstrings
• README