General
34 views
Technical Writing
Quick Definition
Creating clear documentation for technical products and APIs
Full Definition
The practice of creating clear concise documentation for technical products processes and APIs.
Examples
API docs, tutorials, runbooks, architecture decision records
Related Terms
api-documentation
documentation
developer-experience
More General Terms
TDD
Writing tests before code in a red-green-refactor cycle
Open Source
Software with publicly available source code
CI/CD
Automating build test and deployment pipelines
Refactoring
Restructuring code without changing external behavior
12-Factor App
Methodology for building scalable maintainable SaaS apps
Version Control
Systems tracking code changes for collaboration