General
163 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
Container
Lightweight package with everything to run software
API Design
Creating consistent and intuitive APIs for software
Version Control
Systems tracking code changes for collaboration
CQRS
Separating read and write models for better scaling
Monitoring
Observing system behavior for issues and optimization
API Documentation
Documentation describing API usage and integration