docs-style-guide

docs-style-guide

製品ドキュメントやチュートリアルの文体を、内容区分と参照ルールに基づいて作成・レビューするスキル。

AIスキル大辞典による日本語要約
品質評価82/100評価確度:暫定
人気度(GitHub Star) 10発掘スコア 94
01

このSkillでできること

  • 製品ドキュメントやチュートリアルの文体を作成・レビューする
  • 声、時制、語句、包括的な表現を確認する
  • 書式、コードブロック、UI、Markdown、数値・日付表記を確認する
  • 内容区分に応じて参照ルールを適用し、違反を報告する
02

使い方

01
STEP 1

対象コンテンツをdocumentationまたはtutorialsに分類する

02
STEP 2

対象に合うトピックの参照ファイルを選ぶ

03
STEP 3

ルールを適用・引用する前に該当ファイルを読む

04
STEP 4

レビューでは違反、ルールファイル、Do/Don'tの修正例を報告する

03

Skillのインストール

このGitHubリポジトリにあるSkillを確認し、現在の環境に適した方法でインストールしてください。
インストール後、正常に利用できることを確認し、基本的な使い方も簡潔に説明してください。

Repository:
https://github.com/planetabhi/skills
04

このSkillを使うプロンプト例

Skill名を明示すると、意図したSkillを使わせやすくなります。自動発動型では必須とは限りません。

この製品ドキュメントをレビューしてください。まずdocumentationまたはtutorialsに分類し、適用する参照ルールを確認したうえで、文体、時制、語句、Markdown、数値・日付表記の違反を報告してください。
出力例を見る
内容区分: documentation
違反: [該当箇所]
適用ルール: [読み込んだルール]
修正案: [Do/Don'tの例に基づく修正]
05

安全性チェック

自動解析による参考情報です。Skillの安全性を保証するものではありません。

外部API通信明確な記述なし
Shellコマンド実行明確な記述なし
ファイル読み取り明確な記述なし
ファイル書き込み明確な記述なし
ネットワークアクセス明確な記述なし
認証情報明確な記述なし
06

関連Skill