documentation-writer
为 Logseq 项目编写文档
Également disponible depuis: github
开发者花费大量时间创建的文档很快就过时了。此技能分析源代码和模板，自动生成准确、结构良好的模块 README、用户指南和 API 文档。它会在记录之前验证所有命令和示例。
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "documentation-writer". Document the person module
Résultat attendu:
- # 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"
Utilisation de "documentation-writer". Document the build script API
Résultat attendu:
- # 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 ```
Audit de sécurité
SûrPure 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.
Facteurs de risque
⚡ Contient des scripts
🌐 Accès réseau
📁 Accès au système de fichiers
⚙️ Commandes externes
Score de qualité
Ce que vous pouvez construire
记录新模块
通过分析源 EDN 文件中的类、属性和关系，为新模块生成 README。
创建用户指南
为功能、安装和工作流编写分步指南，包含经过测试的命令和示例。
记录脚本和 CLI
为构建脚本、导出工具和命令行界面创建参考文档，包含完整的示例。
Essayez ces prompts
记录 [module-name] 模块。阅读 source/[module-name]/ 中的源文件，生成包含类、属性、使用示例和 Schema.org 引用的综合 README。
使用 [tool or feature] 的新步骤更新 docs/user-guide/installation.md。阅读现有指南并添加准确、经过测试的安装说明。
记录 scripts/[script-name]。分析代码并创建包含参数、选项、示例、退出代码和使用场景的 API 参考。
为 [feature-name] 功能创建用户指南。包括其功能、使用时机、分步说明、示例和故障排除提示。
Bonnes pratiques
- 在将命令和代码示例包含在文档中之前对其进行测试
- 使用具体的、真实的示例而不是通用的占位符
- 交叉引用相关文档并保持链接为最新
Éviter
- 使用占位符而不是经过测试、可工作的示例
- 在文档中留下过时的信息而不更新
- 假设读者具有专家级知识而不提供解释