General
35 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
Data Pipeline
Series of processing steps moving data from source to destination
API Documentation
Documentation describing API usage and integration
Scrum
Agile framework using fixed-length sprints
Event Sourcing
Storing all state changes as immutable event sequences
SOLID
Five design principles for maintainable OOP software
Code Review
Examining code changes before merging for quality