본문으로 건너뛰기
cccskills
무료GitHub에 공개

writing

文章を書く時の心得。ソースコードのコメント、PR概要欄、ドキュメント、wikiのどこに書く時も変わらない、解釈のブレを起こさない文の書き方と、強調記号とカッコ書きの扱いを定める。ソースコードのコメント、PR概要欄、ドキュメント、wikiの文章を書く時、直す時、レビューする時に読み込む。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

설치 방법 보기

포함된 파일(1)

  • SKILL.md3.0 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

文章を書く時の心得

ソースコードのコメント、pull requestの概要欄、ドキュメント、wikiのどこに書く時も、以下の基準に従う。

心得1. 解釈のブレが発生しない文を書く

  • 良くない事は、良くない事だと分かる述語で書く。「patternが遅くなっても落ちない」は、まるで良い事かのようにも読める。失われる働きを述語にして「patternが遅くなった事を検知できない」と書く
  • 目的は完全な節で言い切る。「〜できるよう」「〜で使うため」と書く。「〜用に、」のような体言止めの断片にしない
  • 目的の述語を曖昧な語にしない。「highlightが当たるよう、Xを保持する」ではなく「highlightを判定できるよう、Xを保持する」と書く。「当たる」では、何が成立する事なのかを言い切れていない
  • 理由の後に2つの事柄を「〜し、〜する」でつなぐと、理由がどちらにかかるか曖昧になる
  • 文を他所から写す時は、貼り付け先の前後の文脈に合うか確かめ、書いた後に読み直して意味が通るか確かめる。元の文脈を前提にした省略は、貼り付け先では意味が通らない

心得2. 強調記号で重要性を示さず、文を推敲する

**bold** 等の強調記号で重要性を表現しない。重要なら、語彙、断言の強さ、文の位置で伝わるように文そのものを推敲する。

心得3. カッコ書きで補足説明しない

丸括弧で補足説明を挿入すると、文の構造が曖昧になり読みにくくなる。

  • 補足が親の項目の詳細や判断基準なら、子リストで展開する
  • 補足が背景や理由なら、文を分けて続ける
  • 括弧の中身を先に述べてから本題に入るなど、文の順序を変える
  • 文意を裏返しただけの括弧注記は削る。「実際に書かれた表記を保持する(正規化後ではない)」の括弧の中は、前半が言えた時点で自明である

心得4. 和文と英字の間に空白を入れない

和文と、英字やコードの識別子との間に空白を入れない。Modal を <dialog> に ではなく Modalを<dialog>に と書く。react-bootstrap Modal のような英単語同士の空白は残す。Markdownのinline codeの前後の空白は、この規則の対象外である。

心得5. URLで終わる行の末尾に句点を付けない

起点は <URL> のようにURLで終わる行の末尾に 。 を付けない。

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

Agent Skillを書く時の心得。SKILL.mdに何を書き、何を書かないかの判断基準を定める。AIが読んで従う文書に共通の心得は、kuden:common-rules-for-agent-instructionsにある。 Agent Skillを作成する時、編集する時、レビュー指摘の採否を決める時に読み込む。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

shokai/agent-skills302026년 10월 21일 업데이트

ソースコード中のコメントを書く時の心得。コメントに何を書き、何を書かないかの判断基準と、置く位置、日本語の文体を定める。 ソースコードのコメントを書く時、直す時、レビューする時に読み込む。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

shokai/agent-skills302026년 10월 21일 업데이트

リポジトリのセキュリティ調査を領域ごとに進める。同じサービスを構成する複数のリポジトリを束ねて調査できる。 このsessionは調査を指揮し、領域ごとに起動したsubagentが調査してレポートを出力する。 レポートの問題のトリアージと、問題の自動修正、問題を直すpull requestの状態の同期も指揮する。 複数sessionにまたがる長期作業を想定し、実行するたびに現状を確認して続きの作業を行う。 ユーザーが手動で起動する。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

shokai/agent-skills302026년 10월 21일 업데이트

セキュリティ調査で検出された問題を1つ修正し、pull requestをready for reviewまで仕上げる。 codepatrol skillが起動したsubagentが実行する。ユーザーが直接呼び出す事は想定していない。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

shokai/agent-skills302026년 10월 21일 업데이트

本番に出る前の修正が積まれたrelease pull requestに、デプロイの前後に人間がやる事をまとめたコメントを投稿・更新する。 codepatrol skillが起動したsubagentが実行する。ユーザーが直接呼び出す事は想定していない。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

shokai/agent-skills302026년 10월 21일 업데이트

リポジトリの1つの領域をセキュリティ観点で調査し、Codexの批判的レビューを経てレポートを出力する。 codepatrol skillが起動したsubagentが実行する。ユーザーが直接呼び出す事は想定していない。

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

shokai/agent-skills302026년 10월 21일 업데이트

shokai의 스킬 모두 보기

이 스킬의 문제 신고