Back to Details

doc-writer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Doc Writer

Doc Writer

Skill para crear documentos tecnicos en la estructura correcta del proyecto.
用于在项目中按正确结构创建技术文档的Skill。

Cuando usar esta Skill

何时使用此Skill

  • Usuario pide escribir una spec o especificacion
  • Usuario pide crear un plan de implementacion
  • Usuario pide documentar una decision arquitectonica (ADR)
  • Usuario pide crear documentacion de referencia
  • Cualquier documento que deba ir en 
    docs/
  • 用户要求编写spec或规格说明
  • 用户要求创建实施计划
  • 用户要求记录架构决策（ADR）
  • 用户要求创建参考文档
  • 任何需要放入
    docs/
    目录的文档

Proceso de Creación

创建流程

Paso 1: Buscar estructura de docs existente

步骤1：查找现有文档结构

bash
undefined
bash
undefined

Buscar carpeta docs

查找docs目录

ls -la docs/ 2>/dev/null
ls -la docs/ 2>/dev/null

Listar subcarpetas existentes

列出现有子目录

ls -d docs/*/ 2>/dev/null
undefined
ls -d docs/*/ 2>/dev/null
undefined

Paso 2: Preguntar categoria al usuario

步骤2：向用户确认分类

Si existen subcarpetas en docs/: Ofrecerlas como opciones.
Si no existen subcarpetas, preguntar al usuario qué categorías quiere usar:
CategoriaUso
specs/
Especificaciones de features/sistemas
plans/
Planes de implementacion
architecture/
ADRs, decisiones arquitectonicas
reference/
Documentacion tecnica de referencia
backlog/
Features pendientes, ideas futuras
work-in-progress/
Documentacion de trabajo activo
Formato de pregunta:
¿En qué categoría va este documento?
☐ specs/ - Especificaciones
☐ plans/ - Planes de implementación
☐ architecture/ - ADRs, decisiones
☐ reference/ - Documentación de referencia
☐ [Otra categoría]
如果docs目录下存在子目录：将这些子目录作为选项提供给用户。
如果不存在子目录，询问用户想要使用的分类：
分类用途
specs/
功能/系统的规格说明
plans/
实施计划
architecture/
ADRs、架构决策
reference/
技术参考文档
backlog/
待开发功能、未来构想
work-in-progress/
进行中的工作文档
提问格式：
这份文档属于哪个分类？
☐ specs/ - 规格说明
☐ plans/ - 实施计划
☐ architecture/ - ADR、架构决策
☐ reference/ - 参考文档
☐ [其他分类]

Paso 3: Generar nombre de archivo

步骤3：生成文件名

Formato: 
YYYY-MM-DD-HH-MM-<feature-name>.md
  • Usar fecha y hora actual
  • <feature-name>
    en kebab-case, descriptivo, sin espacios
Ejemplo: 
2025-12-25-14-30-user-authentication.md
格式：
YYYY-MM-DD-HH-MM-<feature-name>.md
  • 使用当前日期和时间
  • <feature-name>
    采用kebab-case格式，描述性强，无空格
示例：
2025-12-25-14-30-user-authentication.md

Paso 4: Crear el documento

步骤4：创建文档

  1. Crear subcarpeta si no existe
  2. Aplicar template segun tipo de documento
  3. Escribir archivo en la ubicacion correcta
  1. 若子目录不存在则创建
  2. 根据文档类型应用对应的模板
  3. 在正确的位置写入文件

Templates

模板

Spec Template

Spec模板

Usar cuando el usuario pide una especificacion o spec de feature:
markdown
undefined
当用户要求编写功能或系统的spec时使用：
markdown
undefined

[Feature Name] - Specification

[功能名称] - Specification

Overview

概述

Brief description of what this feature does.
对该功能作用的简要描述。

Requirements

需求

  • Requirement 1
  • Requirement 2
  • 需求1
  • 需求2

Technical Approach

技术实现方案

How this will be implemented.
该功能的实现方式。

Dependencies

依赖项

  • Dependency 1
  • 依赖项1

Open Questions

待解决问题

  • Question 1?
undefined
  • 问题1？
undefined

Plan Template

计划模板

Usar cuando el usuario pide un plan de implementacion:
markdown
undefined
当用户要求创建实施计划时使用：
markdown
undefined

[Feature Name] - Implementation Plan

[功能名称] - 实施计划

Goal

目标

What we're trying to achieve.
我们想要达成的成果。

Steps

步骤

  1. Step 1
  2. Step 2
  1. 步骤1
  2. 步骤2

Considerations

注意事项

  • Risk/consideration 1
  • 风险/注意事项1

Success Criteria

成功标准

  • Criteria 1
undefined
  • 标准1
undefined

Architecture Template (ADR)

架构模板（ADR）

Usar cuando el usuario pide documentar una decision arquitectonica:
markdown
undefined
当用户要求记录架构决策时使用：
markdown
undefined

ADR: [Decision Title]

ADR: [决策标题]

Status

状态

Proposed | Accepted | Deprecated | Superseded
提议中 | 已通过 | 已弃用 | 已取代

Context

背景

What is the issue that we're seeing that is motivating this decision?
是什么问题促使我们做出这个决策？

Decision

决策

What is the change that we're proposing and/or doing?
我们提议或正在执行的变更是什么？

Consequences

影响

What becomes easier or more difficult because of this change?
undefined
这项变更会让哪些事情变得更简单或更困难？
undefined

Reference Template

参考模板

Usar cuando el usuario pide documentacion de referencia:
markdown
undefined
当用户要求创建参考文档时使用：
markdown
undefined

[Topic] Reference

[主题] Reference

Overview

概述

What this document covers.
本文档涵盖的内容。

Details

详细说明

Technical details and usage.
技术细节及使用方法。

Examples

示例

Code or usage examples.
代码或使用示例。

Related

相关链接

  • Link to related docs

---
  • 相关文档链接

---

Ejemplos de uso

使用示例

Usuario: "Escribime una spec para el sistema de autenticacion"
  1. Buscar docs/: Existe, tiene subcarpetas 
    specs/
    , 
    plans/
  2. Preguntar categoría: "¿En qué categoría va?" → Usuario elige 
    specs/
  3. Nombre: 
    2025-12-25-15-30-authentication-system.md
  4. Crear: 
    docs/specs/2025-12-25-15-30-authentication-system.md
    con Spec Template
用户：“帮我写一个认证系统的spec”
  1. 查找docs/目录：存在，包含子目录
    specs/
    、
    plans/
  2. 询问分类：“这份文档属于哪个分类？” → 用户选择
    specs/
  3. 文件名：
    2025-12-25-15-30-authentication-system.md
  4. 创建文件：
    docs/specs/2025-12-25-15-30-authentication-system.md
    ，并应用Spec模板