General
297 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
Open Source
Software with publicly available source code
Semantic Versioning
Version scheme using MAJOR.MINOR.PATCH format
Virtualization
Creating virtual versions of hardware or OS resources
API Design
Creating consistent and intuitive APIs for software
Monitoring
Observing system behavior for issues and optimization
Event Sourcing
Storing all state changes as immutable event sequences