doc-coauthoring について
doc-coauthoring は、技術文書や提案書、仕様書、意思決定記録の作成を支援するスキルです。背景の整理から内容の反復編集、検証までの流れを扱います。
主な機能
- 01要件、読者、目的の整理
- 02初稿作成、改善、レビュー
- 03明瞭さ、網羅性、実現可能性の確認
- 04仕様書、提案書、決定記録、ガイドに対応
活用シーン
- 01API 文書やアーキテクチャ設計の草案作成
- 02プロジェクト提案や機能案の作成
- 03ADR や技術選定の記録
- 04チュートリアルやマニュアルの作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/doc-coauthoringを入力して読み込まれたか確認します。
詳細
プロジェクトの README より文档协作工作流
当使用此技能
- 编写技术文档
- 创建项目提案
- 起草技术规范
- 决策文档
- 结构化内容创作
工作流程
阶段 1: 上下文转移
- 收集需求和背景
- 确定受众和目标
- 列出关键要点
阶段 2: 内容迭代
- 初稿: 快速写出核心内容
- 完善: 添加细节和示例
- 审核: 检查逻辑和流畅性
阶段 3: 验证
- 受众测试: 是否易于理解
- 完整性: 是否遗漏关键信息
- 可行性: 是否可执行
文档类型
- 技术规范: API 文档、架构设计
- 提案: 项目计划、功能建议
- 决策: ADR、技术选型
- 指南: 教程、手册
最佳实践
- 结构化: 使用清晰的标题层次
- 示例优先: 用代码/示例说明
- 迭代优化: 多次修订完善
触发词
- "写文档"
- "创建提案"
- "起草规范"
- "决策文档"
コメント
Markdown 対応