documentation-writer
Escribir documentación para proyectos Logseq
こちらからも入手できます: github
Los desarrolladores pasan horas creando documentación que rápidamente queda desactualizada. Esta habilidad analiza código fuente y plantillas para generar automáticamente módulos READMEs bien estructurados, guías de usuario y documentación API precisas. Valida todos los comandos y ejemplos antes de documentarlos.
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「documentation-writer」を使用しています。 Documentar el módulo person
期待される結果:
- # Person Module The Person module provides classes for tracking individuals including personal information, professional details, and relationships. ## Classes **Person** - Represents a human being - Parent: Thing - Properties: 36 properties - Use for: Tracking contacts, team members, and individuals **Patient** - Person receiving medical care - Parent: Person - Properties: Medical-related properties ## Properties **email** (URL, :one) - Email address - Used by: Person, Organization - Example: "user@example.com" **jobTitle** (Text, :one) - Job title - Used by: Person - Example: "Senior Engineer"
「documentation-writer」を使用しています。 Documentar la API del script de compilación
期待される結果:
- # Build Script API ## bb scripts/build.clj **Purpose**: Compile templates and generate output files **Usage**: `bb build [options]` **Options**: | Option | Description | Default | |--------|-------------|---------| | --target | Output format | "html" | | --verbose | Show detailed output | false | **Exit Codes**: - 0: Success - 1: Build error - 2: Invalid arguments **Examples**: ```bash # Build with default settings bb build # Build HTML output bb build --target html ```
セキュリティ監査
安全Pure prompt-based skill with no code execution. Static scanner produced 98 false positives by misidentifying markdown documentation syntax as executable code. No network access, no cryptographic operations, no external commands. Previous audit confirmed safe.
リスク要因
⚡ スクリプトを含む
🌐 ネットワークアクセス
📁 ファイルシステムへのアクセス
⚙️ 外部コマンド
品質スコア
作れるもの
Documentar nuevos módulos
Generar READMEs para nuevos módulos analizando clases, propiedades y relaciones en archivos EDN fuente.
Crear guías de usuario
Escribir guías paso a paso para características, instalación y flujos de trabajo con comandos y ejemplos probados.
Documentar scripts y CLIs
Crear documentación de referencia para scripts de compilación, herramientas de exportación e interfaces de línea de comandos con ejemplos completos.
これらのプロンプトを試す
Documentar el módulo [module-name]. Leer los archivos fuente en source/[module-name]/ y generar un README completo con clases, propiedades, ejemplos de uso y referencias Schema.org.
Actualizar docs/user-guide/installation.md con nuevos pasos para [tool or feature]. Leer la guía existente y agregar instrucciones de instalación precisas y probadas.
Documentar scripts/[script-name]. Analizar el código y crear una referencia API con parámetros, opciones, ejemplos, códigos de salida y escenarios de uso.
Crear una guía de usuario para la característica [feature-name]. Incluir qué hace, cuándo usarla, instrucciones paso a paso, ejemplos y consejos para solución de problemas.
ベストプラクティス
- Probar todos los comandos y ejemplos de código antes de incluirlos en la documentación
- Usar ejemplos concretos del mundo real en lugar de marcadores de posición genéricos
- Referenciar documentación relacionada y mantener los enlaces actualizados
回避
- Usar marcadores de posición en lugar de ejemplos probados y funcionales
- Dejar información desactualizada en la documentación sin actualizaciones
- Asumir que los lectores tienen conocimiento de nivel experto sin explicaciones