Kit dokumentasi teknis
Rencanakan dan tulis dokumentasi produk: rencana dokumentasi, panduan gaya, tutorial, panduan cara dan referensi Diataxis, serta panduan pengguna dan admin.
Perencanaan
Documentation Plan Template
StandarDocs plan – audiences and tasks, deliverables inventory, IA, style, pipeline, review, localisation, accessibility, metrics
Technical Writing Style Guide Template
StandarTech writing style guide – voice, grammar do/don't, terminology, UI and code conventions, procedures, inclusive language
Pembelajaran
Quickstart Guide Template
StandarQuickstart – zero to first success, verifiable steps
Diataxis (tutorial)Tutorial Template (Diataxis)
StandarDiátaxis tutorial – learning goals, prerequisites, numbered lessons with visible results, checkpoints, troubleshooting
DiátaxisHow-To Guide Template (Diataxis)
StandarHow-to guide (Diataxis) – goal-first recipe
Diataxis (how-to)Explanation Document Template (Diataxis)
StandarExplanation (Diataxis) – why, trade-offs, limits
Diataxis (explanation)
Desain referensi
Reference Documentation Template (Diataxis)
StandarDiátaxis reference page – neutral, consistently structured entries for functions, types, errors and constants
DiátaxisAPI Overview and Getting Started Template
StandarAPI landing page – what it does, base URLs, auth in 3 steps, first request, key resources, errors, limits, next steps
CLI Reference Template (Man Page Sections)
StandarCommand-line reference in man-page order – synopsis, options, commands, environment, files, exit status, examples
Configuration Reference Template
StandarSettings reference – precedence rules, file format, per-key type/default/range/env var/since, deprecations, validation
Panduan
User Manual Template (ISO/IEC/IEEE 26514)
LengkapFull user manual per ISO/IEC/IEEE 26514 – conventions, notices, concepts, task procedures, reference, errors, accessibility
ISO/IEC/IEEE 26514:2022Installation and Configuration Guide Template (ISO/IEC/IEEE 26514)
LengkapInstall guide – requirements, checklist, per-platform steps, verification, config parameters, upgrade, uninstall, hardening
ISO/IEC/IEEE 26514:2022Administrator Guide Template (ISO/IEC/IEEE 26514)
LengkapAdmin guide – roles, architecture, access, backup/restore, monitoring, maintenance, scaling, security ops, DR, audit
ISO/IEC/IEEE 26514:2022Developer and SDK Guide Template
LengkapDeveloper guide – setup, auth, multi-language quick start, errors, pagination, rate limits, webhooks, sandbox, versioning
Migration Guide Template
StandarUpgrade/migration guide – who is affected, breaking changes table, timeline, checklist, steps, before/after code, rollback
Troubleshooting Guide Template
StandarSymptom/cause/fix index + known issues
Berkas proyek
README Template
StandarLean project README – badges, config table, mermaid
Changelog Template (Keep a Changelog)
StandarKeep a Changelog + SemVer
Keep a ChangelogRelease Notes Template
StandarRelease notes: highlights, features, fixes, breaking changes with migration, deprecations, CVE fixes, upgrade steps