Technical Documentation Kit

Docs plan – audiences and tasks, deliverables inventory, IA, style, pipeline, review, localisation, accessibility, metrics

Tech writing style guide – voice, grammar do/don't, terminology, UI and code conventions, procedures, inclusive language

Quickstart – zero to first success, verifiable steps

Diátaxis tutorial – learning goals, prerequisites, numbered lessons with visible results, checkpoints, troubleshooting

How-to guide (Diataxis) – goal-first recipe

Explanation (Diataxis) – why, trade-offs, limits

Diátaxis reference page – neutral, consistently structured entries for functions, types, errors and constants

API landing page – what it does, base URLs, auth in 3 steps, first request, key resources, errors, limits, next steps

Command-line reference in man-page order – synopsis, options, commands, environment, files, exit status, examples

Settings reference – precedence rules, file format, per-key type/default/range/env var/since, deprecations, validation

Full user manual per ISO/IEC/IEEE 26514 – conventions, notices, concepts, task procedures, reference, errors, accessibility

Install guide – requirements, checklist, per-platform steps, verification, config parameters, upgrade, uninstall, hardening

Admin guide – roles, architecture, access, backup/restore, monitoring, maintenance, scaling, security ops, DR, audit

Developer guide – setup, auth, multi-language quick start, errors, pagination, rate limits, webhooks, sandbox, versioning

Upgrade/migration guide – who is affected, breaking changes table, timeline, checklist, steps, before/after code, rollback

Symptom/cause/fix index + known issues

Lean project README – badges, config table, mermaid

Keep a Changelog + SemVer

Release notes: highlights, features, fixes, breaking changes with migration, deprecations, CVE fixes, upgrade steps