documentation
より良いドキュメントを作成する
也可從以下取得: Joseph OBrien,Joseph OBrien,CrazySwami,DaoThiHuong2111
ドキュメントは構造化されておらず、読みにくいものになりがちです。このスキルは、適切な構造、フォーマット、視覚的階層を持つ整理されたmarkdownファイルを作成するための明確なガイドラインを提供します。
下載技能 ZIP
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
開啟並開始使用
測試它
正在使用「documentation」。 Write a getting started guide for my Python project
預期結果:
- • 前提条件、インストール、クイックスタート、例のためのヘッダーを備えたgetting-started.mdを作成
- • コマンドと設定のコードブロックを使用
- • クイックリファレンスステップに箇条書きを追加
- • ファイルに直接書き込み、場所を知らせる
正在使用「documentation」。 Create a project proposal for a new feature
預期結果:
- • 問題提起、解決策、タイムライン、成果物を備えたproposal.mdを生成
- • 簡単なナビゲーションのための明確なセクションとヘッダーを使用
- • 提案に適した説得力があるが正直なトーンを維持
- • 説明的な命名でproposalsフォルダに保存
正在使用「documentation」。 Document the API endpoints for my REST service
預期結果:
- • 各エンドポイントのためのセクションを持つapi.mdを作成
- • リクエスト/レスポンス形式にテーブルを使用
- • 各操作のコード例を含める
- • 論理的フローのためにリソースタイプ別に整理
安全審計
安全Pure prompt-based skill containing only documentation guidelines. No code execution, no file access beyond standard AI capabilities, no network calls, and no external commands. Static findings are false positives - the analyzer misidentified documentation-related text as cryptographic references and markdown backticks as shell execution. This is a set of best practices for writing documentation.
風險因素
🌐 網路存取 (1)
⚙️ 外部命令 (2)
品質評分
你能建構什麼
技術ドキュメントを作成する
適切な構造で明確なREADME、APIドキュメント、技術ガイドを作成する
プロジェクト計画を起草する
具体的なステップと論理的フローで実行可能な計画や提案を作成する
長文コンテンツを構造化する
ヘッダーと視覚的階層を使用して、ブレインストームのメモ、ガイド、仕様を整理する
試試這些提示
Write a README for my project in PROJECT/README.md. Include sections for overview, installation, usage, and contributing.
Create API documentation in docs/api.md. Document the main endpoints, request/response formats, and authentication.
Write a project proposal in proposals/feature-x.md. Include problem statement, proposed solution, timeline, and expected outcomes.
Create architecture documentation in docs/architecture.md. Include system overview, component diagram, data flow, and design decisions.
最佳實務
- コンテンツをターミナルにダンプするのではなく、常にファイルに書き込む
- 明確な構造とナビゲーションを作成するためにヘッダーを使用する
- 可読性のためにテキストをリスト、テーブル、コードブロックで区切る
避免
- ファイルせずにターミナルに直接長文コンテンツをダンプする
- トーンと構造を選択する際にドキュメントの目的を無視する
- フォーマットや視覚的階層なしで文字の壁を使用する