- Installs
- 59
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/rtgs2017/nagaagent --skill document-writer- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads document-writer automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
文档编写技能
本技能提供专业的技术文档编写能力。
支持的文档类型
1. README 文档
- 项目简介
- 安装说明
- 快速开始
- 配置选项
- API 参考
- 贡献指南
2. API 文档
- 接口描述
- 请求/响应格式
- 参数说明
- 错误码
- 使用示例
3. 用户手册
- 功能介绍
- 操作步骤
- 常见问题
- 故障排除
4. 技术规范
- 架构设计
- 数据模型
- 流程图
- 接口规范
写作原则
清晰性
- 使用简洁明了的语言
- 避免歧义和模糊表达
- 提供具体示例
完整性
- 覆盖所有必要信息
- 包含先决条件
- 说明边界情况
可用性
- 逻辑结构清晰
- 易于导航
- 提供搜索友好的标题
文档模板
README 模板
# 项目名称
简短描述（一句话）
## 特性
- 特性 1
- 特性 2
## 安装
\`\`\`bash
npm install xxx
\`\`\`
## 快速开始
\`\`\`javascript
// 示例代码
\`\`\`
## 配置
| 参数 | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| ... | ... | ... | ... |
## 许可证
MIT
使用流程
- 确定文档类型和目标读者
- 收集必要信息
- 按模板结构组织内容
- 审查和优化表达
- 添加示例和图表
FAQ
What does the document-writer skill do?
专业文档编写技能。用于撰写技术文档、README、API文档、用户手册等。当用户需要编写或改进文档时使用此技能。
How do I install document-writer?
Run npx skills add https://github.com/rtgs2017/nagaagent --skill document-writer in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/document-writer/ (personal) or .claude/skills/document-writer/ (project).
Which AI agents can use document-writer?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is document-writer safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains document-writer?
It is published by rtgs2017 in rtgs2017/nagaagent. It has 59 recorded installs.
More from rtgs2017/nagaagent
file-manager
rtgs2017/nagaagent
文件管理技能。用于创建、移动、复制、删除文件和文件夹，整理目录结构。当用户需要管理文件、整理文件夹或批量处理文件时使用。
web-search
rtgs2017/nagaagent
网络搜索和信息检索技能。用于搜索网页、查询实时信息、获取新闻资讯。当用户询问需要联网查询的问题、最新信息或实时数据时使用。
code-review
rtgs2017/nagaagent
代码审查和质量分析技能。用于审查代码、发现潜在问题、提供改进建议。当用户请求代码审查、代码质量分析或最佳实践建议时使用。
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.