Skip to content

openjny/writing-skills

v1.1.0MIT

文章表現のレビュー、技術文書の書き方、Markdownのリンク・構造検証を提供する。

technical-writing

技術文書を、読み手が 1 回で理解して行動できるように書く・レビューする。文書のモード選択(チュートリアル、ハウツー、リファレンス、解説)、手順の書き方、一文一義、誤読の余地の排除、用語統一、見出し・リンク・リストの規約、PR 説明とコミットメッセージを扱う。AI 臭の除去は anti-ai-writing、Markdown のリンク・構造の検査は markdown-check が担当する。Use when: README、設計書、RFC、手順書、リファレンス、PR 説明、コミットメッセージを書く・直す・レビューするとき。Triggers: technical writing、テクニカルライティング、技術文書、手順書、分かりにくい文書、ドキュメントレビュー

Read SKILL.md at the source

Pinned to revision f6f5fcdb4825, so it is the text this page describes rather than whatever the author pushed since.

Files

Every link opens the file at its source, pinned to the revision this page describes.