General
165 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
Design Patterns
Reusable solutions to common software design problems
Site Reliability
Engineering approach to IT operations with software practices
Documentation as Code
Applying dev practices to documentation management
Inversion of Control
Design principle transferring program flow control to framework
Scrum
Agile framework using fixed-length sprints
SOLID
Five design principles for maintainable OOP software