mcpField
D
document-writer

document-writer

github.com/rtgs2017ドキュメント1.5k59 回インストール11 週間前に更新
リポジトリ

document-writer について

document-writer は、プロジェクト文書や API 仕様などを作成するためのスキルです。複数の文書形式に対応し、明確さ、網羅性、見つけやすさを重視します。

主な機能

  1. 01README、API 文書、ユーザーマニュアルの作成
  2. 02技術仕様やアーキテクチャ説明の整理
  3. 03対象読者に合わせた構成
  4. 04例の追加と境界条件の確認
  5. 05見出しとナビゲーションの改善

活用シーン

  1. 01プロジェクトの README とクイックスタートの作成
  2. 02API パラメーター、応答、エラーコードの記述
  3. 03操作ガイドとトラブルシューティングの準備
  4. 04アーキテクチャ、データモデル、処理の記録

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/rtgs2017/nagaagent --skill document-writer

インストール後、Claude Code で/document-writerを入力して読み込まれたか確認します。

詳細

プロジェクトの README より

文档编写技能

本技能提供专业的技术文档编写能力。

支持的文档类型

1. README 文档
  • 项目简介
  • 安装说明
  • 快速开始
  • 配置选项
  • API 参考
  • 贡献指南
2. API 文档
  • 接口描述
  • 请求/响应格式
  • 参数说明
  • 错误码
  • 使用示例
3. 用户手册
  • 功能介绍
  • 操作步骤
  • 常见问题
  • 故障排除
4. 技术规范
  • 架构设计
  • 数据模型
  • 流程图
  • 接口规范

写作原则

清晰性
  • 使用简洁明了的语言
  • 避免歧义和模糊表达
  • 提供具体示例
完整性
  • 覆盖所有必要信息
  • 包含先决条件
  • 说明边界情况
可用性
  • 逻辑结构清晰
  • 易于导航
  • 提供搜索友好的标题

文档模板

README 模板
# 项目名称

简短描述（一句话）

## 特性

- 特性 1
- 特性 2

## 安装

\`\`\`bash
npm install xxx
\`\`\`

## 快速开始

\`\`\`javascript
// 示例代码
\`\`\`

## 配置

| 参数 | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| ... | ... | ... | ... |

## 许可证

MIT

使用流程

  1. 确定文档类型和目标读者
  2. 收集必要信息
  3. 按模板结构组织内容
  4. 审查和优化表达
  5. 添加示例和图表

コメント

Markdown 対応