Skip to content

執筆方針(文章のルール)

このリポジトリのドキュメントは、Rhino / Grasshopper の実務に直結する技術資料として整備します。読みやすさよりもまず 正確さ・再現性・検証可能性 を優先します。

1. 出典・根拠・ファクトチェック

  • 出典の明記: 仕様・数値・機能の断定を行う場合、根拠を示す
    • 望ましい根拠: 公式ドキュメント、公式ヘルプ、実測(手順付き)、再現可能な検証ファイル
    • 外部リンクの場合: 参照先のページタイトル(または製品名)を本文中に記載し、リンクする
  • 推測の禁止(断定しない): 根拠がない情報は断定しない
    • 推測が必要な場合は 推測であることを明示し、確認方法(再現手順)を併記する
  • ファクトチェックの観点:
    • 記載している単位(mm/inch、角度、許容差)が一貫しているか
    • バージョン差(Rhino 7/8、Grasshopper標準/プラグイン)で挙動が変わらないか
    • “一般に”と書いた事項が例外だらけになっていないか(例外条件を明記できているか)

2. 文体・トーン(口語を避ける)

  • 技術文書の文体: 「〜です/〜ます」を基本に、過度な口語・感想語を避ける
  • 禁止/非推奨表現(例):
    • 「まず結論」「ざっくり」「〜っぽい」「強い/弱い(根拠なし)」「多分」「いい感じ」「〜な気がする」
    • 断定しないための曖昧語を多用すること(重要箇所ほど、条件と範囲を明確にする)
  • 推奨表現(例):
    • 「〜の場合は〜を推奨する」「〜を保証する/しない」「前提条件は〜」「失敗しやすい条件は〜」

3. 数式・プログラム・アルゴリズムに基づく説明

  • “なぜそうなるか”を分解する: 次のいずれか(または複合)で裏付ける
    • アルゴリズムの要点(入力・出力・制約・最適化対象)
    • 幾何学/数式(必要な最小限。式よりも条件と意味を重視)
    • 再現手順(Grasshopperの最小定義、操作手順、パラメータ例)
  • 説明レベルの統一:
    • 実装詳細を網羅しない代わりに、挙動差が出るパラメータ(次数、許容誤差、公差等)を明確にする
    • 断定できない場合は「確認観点」と「再現手順」を残す

4. 記事の構成ルール(Q&A形式を基本とする)

このドキュメントは、Q&A形式(一問一答)を基本として構成します。説明的な文章よりも、実務でよくある質問とその回答の形式で記述することで、読みやすさと実用性を向上させます。

Q&A形式の基本構造

  • 質問(Q): 実務でよくある疑問や問題を明確に提示
  • 回答(A): 簡潔で実用的な回答を提供
  • セクション分け: 関連する質問をグループ化(例: 「基本概念」「パラメータ設計」「トラブルシューティング」)

Q&A形式の利点

  • 検索性: 特定の疑問に対する回答を素早く見つけられる
  • 実用性: 実務で直面する問題に直接対応できる
  • 明確性: 説明的な文章よりも意図が明確になる

従来の構成要素との統合

Q&A形式を基本としつつ、以下の要素も必要に応じて含めます:

  • 導入: ページの目的と対象読者(簡潔に)
  • 前提: 必要な入力、単位、公差、バージョン、プラグイン有無(Q&A内で明記)
  • 手順/型: 最小構成のワークフロー(Mermaid図が有効、Q&A内で参照)
  • 選定基準: どのコンポーネントをいつ選ぶか(Q&A形式で提示)
  • 失敗例: 典型的な破綻と回避策(Q&A形式で提示)
  • チェックリスト: 確認ポイント(Q&A形式で提示)
  • 参考: 出典、関連ページ(Q&A内で参照)

5. 最終チェックリスト(コミット前)

  • [ ] 断定している記述に 根拠(出典/再現手順/数式) がある
  • [ ] 推測が混ざっていない(混ざる場合は 推測と明示し、確認方法がある)
  • [ ] 口語・感想語が多くない(「〜っぽい」「ざっくり」等を排除)
  • [ ] 単位・公差・条件が明示されている
  • [ ] “どのコンポーネントを使うべきか”が判断できる(選定基準がある)

6. 図・ダイアグラム(GrasshopperはMermaidを基本)- Grasshopperの配線図はMermaidを基本とし、スクリーンショットの貼り付けを避けます。

  • 理由: 文章と同様に 差分管理・再編集・検索 ができ、説明の再現性が上がるため
  • ガイド: docs/grasshopper/diagrams.md(Mermaidテンプレ、命名規則、抽象度の基準)
  • 例外(スクリーンショットが有効なケース):
    • UI設定・オプション画面の位置説明、表示上の不具合の再現、プラグイン固有UIの説明
    • ただし、配線やデータフローの説明が主目的ならMermaidへ寄せる

Released under the MIT License.