Markdown Editor

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.

Paso 1

Planificación

  1. Documentation Plan Template

    Estándar

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

  2. Technical Writing Style Guide Template

    Estándar

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

Paso 2

Aprendizaje

  1. Quickstart Guide Template

    Estándar

    Quickstart – zero to first success, verifiable steps

    Diataxis (tutorial)
  2. Tutorial Template (Diataxis)

    Estándar

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

    Diátaxis
  3. How-To Guide Template (Diataxis)

    Estándar

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

    Diataxis (how-to)
  4. Explanation Document Template (Diataxis)

    Estándar

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

    Diataxis (explanation)
Paso 3

Diseños de referencia

  1. Reference Documentation Template (Diataxis)

    Estándar

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

    Diátaxis
  2. API Overview and Getting Started Template

    Estándar

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

  3. CLI Reference Template (Man Page Sections)

    Estándar

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

  4. Configuration Reference Template

    Estándar

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

Paso 4

Guías

  1. User Manual Template (ISO/IEC/IEEE 26514)

    Completa

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

    ISO/IEC/IEEE 26514:2022
  2. Installation and Configuration Guide Template (ISO/IEC/IEEE 26514)

    Completa

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

    ISO/IEC/IEEE 26514:2022
  3. Administrator Guide Template (ISO/IEC/IEEE 26514)

    Completa

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

    ISO/IEC/IEEE 26514:2022
  4. Developer and SDK Guide Template

    Completa

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

  5. Migration Guide Template

    Estándar

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

  6. Troubleshooting Guide Template

    Estándar

    Symptom/cause/fix index + known issues

Paso 5

Archivos del proyecto

  1. README Template

    Estándar

    Lean project README – badges, config table, mermaid

  2. Changelog Template (Keep a Changelog)

    Estándar

    Keep a Changelog + SemVer

    Keep a Changelog
  3. Release Notes Template

    Estándar

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