المهارات documentation-writer
📝
documentation-writer
آمن ⚡
يحتوي على سكربتات🌐
الوصول إلى الشبكة📁
الوصول إلى نظام الملفات⚙️
الأوامر الخارجية
为 Logseq 项目编写文档
متاح أيضًا من: github
开发者花费大量时间创建的文档很快就过时了。此技能分析源代码和模板，自动生成准确、结构良好的模块 README、用户指南和 API 文档。它会在记录之前验证所有命令和示例。
يدعم: Claude Codex Code(CC)
1
تنزيل ZIP المهارة
2
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
3
فعّل وابدأ الاستخدام
اختبرها
استخدام "documentation-writer". Document the person module
النتيجة المتوقعة:
- # 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". Document the build script API
النتيجة المتوقعة:
- # 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 ```
التدقيق الأمني
آمنv5 • 1/16/2026
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.
2
الملفات التي تم فحصها
741
الأسطر التي تم تحليلها
4
النتائج
5
إجمالي عمليات التدقيق
عوامل الخطر
⚡ يحتوي على سكربتات
لم يتم تسجيل أي مواقع محددة
🌐 الوصول إلى الشبكة
لم يتم تسجيل أي مواقع محددة
📁 الوصول إلى نظام الملفات
لم يتم تسجيل أي مواقع محددة
⚙️ الأوامر الخارجية
لم يتم تسجيل أي مواقع محددة
تم تدقيقه بواسطة: claude عرض سجل التدقيق →
درجة الجودة
38
الهندسة المعمارية
100
قابلية الصيانة
87
المحتوى
21
المجتمع
100
الأمان
87
الامتثال للمواصفات
ماذا يمكنك بناءه
记录新模块
通过分析源 EDN 文件中的类、属性和关系，为新模块生成 README。
创建用户指南
为功能、安装和工作流编写分步指南，包含经过测试的命令和示例。
记录脚本和 CLI
为构建脚本、导出工具和命令行界面创建参考文档，包含完整的示例。
جرّب هذه الموجهات
记录新模块
记录 [module-name] 模块。阅读 source/[module-name]/ 中的源文件，生成包含类、属性、使用示例和 Schema.org 引用的综合 README。
更新安装指南
使用 [tool or feature] 的新步骤更新 docs/user-guide/installation.md。阅读现有指南并添加准确、经过测试的安装说明。
编写 API 文档
记录 scripts/[script-name]。分析代码并创建包含参数、选项、示例、退出代码和使用场景的 API 参考。
创建功能指南
为 [feature-name] 功能创建用户指南。包括其功能、使用时机、分步说明、示例和故障排除提示。
أفضل الممارسات
- 在将命令和代码示例包含在文档中之前对其进行测试
- 使用具体的、真实的示例而不是通用的占位符
- 交叉引用相关文档并保持链接为最新
تجنب
- 使用占位符而不是经过测试、可工作的示例
- 在文档中留下过时的信息而不更新
- 假设读者具有专家级知识而不提供解释
الأسئلة المتكررة
此技能可以创建哪些类型的文档？
模块 README、用户指南、技术参考、脚本和命令的 API 文档以及功能文档。
此技能支持哪些文件格式？
Logseq 模板使用 EDN 格式，文档文件使用 Markdown，构建脚本使用 Clojure。
此技能可以与任何编程项目一起使用吗？
它最适合 Logseq 模板图。对于其他项目，它可以读取源文件，但可能无法遵循最佳结构。
此技能会存储或传输我的数据吗？
不会。这是一种基于提示的技能，使用标准 Claude Code 工具在本地生成文档。
此技能使用哪些工具？
使用 Read、Write、Edit、Grep、Glob 和 Bash 工具来分析文件并验证文档的准确性。
这与自动化文档工具有什么不同？
与 JSDoc 或 Sphinx 不同，此技能创建针对特定受众和使用场景的人工可读指南。