Search

Documentation

All articles tagged with "Documentation"

8 Total Articles

Documentation Debt Explained

Documentation debt: Docs lag behind reality when code changes but docs don't. Accumulates through rushed features, team turnover, and neglected maintenance.

Technical Documentation Explained

Technical documentation types: API docs (endpoints, parameters, examples), user guides (workflows, screenshots), architecture docs (system design, decisions).

Documentation Systems Explained

Documentation systems: wikis for collaborative linked knowledge, README hierarchy from project to file level, and docs-as-code with version control.

Knowledge Writing Explained

Knowledge writing captures expertise: explicit knowledge with documented steps and procedures, plus tacit knowledge including context and judgment calls.

Documentation System Best Practices

Documentation system best practices: Easy to find with search and navigation, maintained regularly with review cycles, clear ownership, and version control.