Kit de documentación técnica
Planifica y escribe la documentación del producto: plan de documentación, guía de estilo, tutoriales, guías prácticas y referencias Diataxis, guías de usuario.
Planificación
Documentation Plan Template
EstándarDocs plan – audiences and tasks, deliverables inventory, IA, style, pipeline, review, localisation, accessibility, metrics
Technical Writing Style Guide Template
EstándarTech writing style guide – voice, grammar do/don't, terminology, UI and code conventions, procedures, inclusive language
Aprendizaje
Quickstart Guide Template
EstándarQuickstart – zero to first success, verifiable steps
Diataxis (tutorial)Tutorial Template (Diataxis)
EstándarDiátaxis tutorial – learning goals, prerequisites, numbered lessons with visible results, checkpoints, troubleshooting
DiátaxisHow-To Guide Template (Diataxis)
EstándarHow-to guide (Diataxis) – goal-first recipe
Diataxis (how-to)Explanation Document Template (Diataxis)
EstándarExplanation (Diataxis) – why, trade-offs, limits
Diataxis (explanation)
Diseños de referencia
Reference Documentation Template (Diataxis)
EstándarDiátaxis reference page – neutral, consistently structured entries for functions, types, errors and constants
DiátaxisAPI Overview and Getting Started Template
EstándarAPI 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)
EstándarCommand-line reference in man-page order – synopsis, options, commands, environment, files, exit status, examples
Configuration Reference Template
EstándarSettings reference – precedence rules, file format, per-key type/default/range/env var/since, deprecations, validation
Guías
User Manual Template (ISO/IEC/IEEE 26514)
CompletaFull 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)
CompletaInstall guide – requirements, checklist, per-platform steps, verification, config parameters, upgrade, uninstall, hardening
ISO/IEC/IEEE 26514:2022Administrator Guide Template (ISO/IEC/IEEE 26514)
CompletaAdmin guide – roles, architecture, access, backup/restore, monitoring, maintenance, scaling, security ops, DR, audit
ISO/IEC/IEEE 26514:2022Developer and SDK Guide Template
CompletaDeveloper guide – setup, auth, multi-language quick start, errors, pagination, rate limits, webhooks, sandbox, versioning
Migration Guide Template
EstándarUpgrade/migration guide – who is affected, breaking changes table, timeline, checklist, steps, before/after code, rollback
Troubleshooting Guide Template
EstándarSymptom/cause/fix index + known issues
Archivos del proyecto
README Template
EstándarLean project README – badges, config table, mermaid
Changelog Template (Keep a Changelog)
EstándarKeep a Changelog + SemVer
Keep a ChangelogRelease Notes Template
EstándarRelease notes: highlights, features, fixes, breaking changes with migration, deprecations, CVE fixes, upgrade steps