leter/zh-tech-writing

写中文技术文档的 Agent Skill,基于阮一峰《中文技术文档的写作规范》:短句、平实、没有 AI 腔

解決する問題

中国語の技術文書における「AIらしい書き方」を排除します。多くのLLMが生成するテキストは冗長で、マーケティング用語が多く、エンジニアにとって不自然に感じる反復的な文構造を持っています。このプロジェクトは、技術文書(README、設計書、API仕様、チュートリアル)が簡潔で事実に基づき、専門的であることを保証するためのルールセットとワークフローを提供します。

仕組み

これはClaude Codeなどのツールと互換性のある「Agent Skill」として実装されています。AIを特定の執筆プロセスに導きます:

  1. 対象読者の定義:対象読者と期待される成果を特定します。
  2. ルールベースの下書き:文の長さ(各節20文字未満)、能動態、直接的な動詞に関する厳格なルールを適用します。
  3. AIらしさの除去:14項目の「AIらしさチェックリスト」を使用して、決まり文句、マーケティング形容詞、翻訳調の表現を特定し除去します。
  4. 自動フォーマット:autocorrectツールと統合し、中国語と英語の文字間のスペースを自動修正し、句読点を修正します。
  5. 手動調整:引用符や省略記号などの特定の記号について最終チェックを行います。

対象者

AIが生成した中国語の文書が、一般的なAIアシスタントではなく人間のエンジニアが書いたように聞こえることを望む開発者やテクニカルライター。

ハイライト

  • 事実重視:曖昧な形容詞(例:「強力」、「シームレス」)を具体的な事実、数字、エラーメッセージに置き換えます。
  • 標準化:阮一峰の中国語技術文書スタイルガイドなどの確立されたガイドラインに基づいています。
  • ツール統合:skills CLIと連携し、autocorrectによる自動句読点修正をサポートします。
  • カスタマイズ可能なワークフロー:ファイルを直接書き換えるか、「原文 → 修正 → 理由」形式の改善提案リストを提供するかのいずれかで使用できます。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト