General
296 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
API Design
Creating consistent and intuitive APIs for software
Event Sourcing
Storing all state changes as immutable event sequences
Technical Debt
Cost of rework from easy solutions over better ones
DevSecOps
Integrating security into DevOps processes
Inversion of Control
Design principle transferring program flow control to framework
Scalability
Ability to handle increased load by adding resources