Back to Details

doc-organizer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Doc Organizer

Doc Organizer

Skill para organizar y categorizar documentos tecnicos existentes en la estructura correcta del proyecto.
用于将项目中现有技术文档整理并分类至正确结构的Skill。

Cuando usar esta Skill

何时使用此Skill

  • Usuario pide "organizar", "reorganizar", "categorizar" documentos
  • Usuario pide "ordenar docs" o "mover documentos a carpetas"
  • Se detectan archivos 
    .md
    sueltos directamente en 
    docs/
    sin subcarpeta
  • 用户提出“整理”“重新整理”“分类”文档的需求
  • 用户提出“排序文档”或“将文档移至文件夹”的需求
  • 检测到
    docs/
    目录下存在未放入子文件夹的零散
    .md
    文件

Proceso de Organizacion

整理流程

Paso 1: Inspeccionar estado actual

步骤1：检查当前状态

bash
undefined
bash
undefined

Archivos sueltos en docs/ (sin subcarpeta)

docs/目录下的零散文件（未在子文件夹中）

ls docs/*.md 2>/dev/null
ls docs/*.md 2>/dev/null

Carpetas existentes y su contenido

现有文件夹及其内容

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

Listar todos los archivos md

列出所有md文件

find docs -name "*.md" -type f 2>/dev/null
undefined
find docs -name "*.md" -type f 2>/dev/null
undefined

Paso 2: Preguntar por categorias

步骤2：询问分类方式

Presentar al usuario las opciones disponibles:
  1. Categorias existentes detectadas en el proyecto
  2. Categorias sugeridas si no existen:
CategoriaUso
specs/
Especificaciones de features/sistemas
plans/
Planes de implementacion
architecture/
ADRs, decisiones arquitectonicas
reference/
Documentacion tecnica de referencia
Formato de pregunta:
Categorias disponibles:
- specs/ - Especificaciones de features/sistemas
- plans/ - Planes de implementacion
- architecture/ - ADRs, decisiones arquitectonicas
- reference/ - Documentacion tecnica de referencia
- [Crear nueva categoria]

Cuales quieres usar para organizar?
向用户展示可选的分类选项：
  1. 检测到的项目中现有分类
  2. 若不存在现有分类，则提供建议分类：
分类路径用途
specs/
功能/系统规格说明
plans/
实施计划
architecture/
架构决策记录（ADRs）、架构决策
reference/
技术参考文档
提问格式：
可用分类：
- specs/ - 功能/系统规格说明
- plans/ - 实施计划
- architecture/ - 架构决策记录（ADRs）、架构决策
- reference/ - 技术参考文档
- [创建新分类]

你希望使用哪些分类来整理文档？

Paso 3: Analizar documentos y sugerir categorizacion

步骤3：分析文档并建议分类

Para cada documento encontrado:
  1. Leer contenido (primeras ~50 lineas)
  2. Detectar tipo por keywords:
Keywords detectadosCategoria sugerida
"ADR", "Decision", "Status: Accepted/Proposed", "Context", "Consequences"
architecture/
"Specification", "Requirements", "Spec", "Technical Approach"
specs/
"Plan", "Implementation", "Steps", "Timeline", "Goal"
plans/
"Reference", "Guide", "How to", "Examples", "Usage"
reference/
  1. Presentar sugerencias al usuario:
Analisis de documentos:

authentication-notes.md
   Detectado: Menciona "requirements" y "technical approach"
   Sugerencia: specs/
   Mover a specs/? [Y/n/otra categoria]

db-migration-decision.md
   Detectado: Contiene "Status: Accepted", "Context", "Decision"
   Sugerencia: architecture/ (es un ADR)
   Mover a architecture/? [Y/n/otra categoria]
针对每个检测到的文档：
  1. 读取内容（前约50行）
  2. 通过关键词检测文档类型：
检测到的关键词建议分类
"ADR", "Decision", "Status: Accepted/Proposed", "Context", "Consequences"
architecture/
"Specification", "Requirements", "Spec", "Technical Approach"
specs/
"Plan", "Implementation", "Steps", "Timeline", "Goal"
plans/
"Reference", "Guide", "How to", "Examples", "Usage"
reference/
  1. 向用户展示分类建议：
文档分析结果：

authentication-notes.md
   检测到：提及"requirements"和"technical approach"
   建议分类：specs/
   是否移至specs/？ [Y/n/其他分类]

db-migration-decision.md
   检测到：包含"Status: Accepted", "Context", "Decision"
   建议分类：architecture/（属于架构决策记录ADR）
   是否移至architecture/？ [Y/n/其他分类]

Paso 4: Ejecutar reorganizacion

步骤4：执行整理操作

Para cada documento confirmado:
  1. Crear carpeta destino si no existe:
bash
mkdir -p docs/<categoria>/
  1. Mover archivo preservando historial git:
bash
git mv docs/<archivo>.md docs/<categoria>/<archivo>.md
  1. Renombrar al formato estandar si no lo tiene:
    • Formato: 
      YYYY-MM-DD-HH-MM-<name>.md
    • Ejemplo: 
      2025-12-25-15-30-authentication-notes.md
针对每个用户确认的文档：
  1. 若目标文件夹不存在则创建：
bash
mkdir -p docs/<categoria>/
  1. 保留Git历史记录移动文件：
bash
git mv docs/<archivo>.md docs/<categoria>/<archivo>.md
  1. 若文件未遵循标准格式则重命名：
    • 标准格式：
      YYYY-MM-DD-HH-MM-<name>.md
    • 示例：
      2025-12-25-15-30-authentication-notes.md

Paso 5: Resumen final

步骤5：最终总结

Mostrar resultado de la organizacion:
Organizacion completada:
- 3 archivos movidos a specs/
- 2 archivos movidos a architecture/
- 1 archivo movido a plans/
- 0 archivos sin categorizar

Archivos reorganizados:
- docs/specs/2025-12-25-15-30-authentication-notes.md
- docs/architecture/2025-12-25-15-31-db-migration-decision.md
- ...
展示整理结果：
整理完成：
- 3个文件已移至specs/
- 2个文件已移至architecture/
- 1个文件已移至plans/
- 0个文件未分类

已整理的文件：
- docs/specs/2025-12-25-15-30-authentication-notes.md
- docs/architecture/2025-12-25-15-31-db-migration-decision.md
- ...

Ejemplo de uso

使用示例

Usuario: "Organiza los documentos en docs/"
  1. Inspeccionar: Encuentra 3 archivos .md sueltos en docs/
  2. Preguntar categorias: Usuario selecciona specs/, plans/, architecture/
  3. Analizar cada archivo y sugerir categoria
  4. Usuario confirma movimientos
  5. Ejecutar: 
    git mv
    para cada archivo
  6. Mostrar resumen: "3 archivos reorganizados"
用户：“整理docs/里的文档”
  1. 检查：发现docs/目录下有3个零散的.md文件
  2. 询问分类：用户选择specs/、plans/、architecture/
  3. 分析每个文件并建议分类
  4. 用户确认移动操作
  5. 执行：对每个文件执行
    git mv
    命令
  6. 展示总结：“3个文件已完成整理”