Skip to content

fjordllc/FBC_Press

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FBC Press

このリポジトリは、FBC Press シリーズの書籍を一貫した方針で執筆・編集するための運用ドキュメント集です。

目的は、特定の 1 冊の原稿を管理することではありません。
シリーズ全体で文体、構成、説明順、図版、サンプルコード、レビュー基準を揃えるための編集基盤として使います。

このリポジトリにあるもの

  • STYLE_GUIDE.md FBC Press らしい文体、構成、説明順、図版、コード例、価値観を定義した中核ガイドです。

  • WRITING_PROMPT.md 章を書き始める前に執筆者へ渡す、コピーして使えるプロンプトです。

  • CHAPTER_TEMPLATE.md 各章を執筆するときの雛形です。章導入、節構成、実務判断、参考資料までの基本型をまとめています。

  • TERMS.md シリーズ全体で表記を揺らさないための用語統一表です。

  • REVIEW_CHECKLIST.md 執筆者の自己点検と編集レビューに使うチェックリストです。

  • SAMPLE_CHAPTER.md FBC Press らしい説明の流れを確認するための短い見本章です。

  • FIGURE_GUIDE.md 図版の役割、使う場面、キャプション、alt テキスト、レビュー観点をまとめたガイドです。

  • BOOK_OUTLINE_TEMPLATE.md 新しい書籍の全体構成を設計するときの雛形です。

  • RESEARCH_RULES.md 一次情報の優先順位、バージョン確認、技術調査時の基本ルールをまとめています。

  • REFERENCE_CHECK.md 章末の参考資料を掲載する前に確認する手順です。

  • APPENDIX_TEMPLATE.md 付録と演習を作るときの雛形です。

  • REPOSITORY_STRUCTURE.md 書籍リポジトリの推奨ディレクトリ構成、ディレクトリ名ルール、命名規則をまとめています。

  • BUILD_AND_PUBLISH.md ローカル確認、本番ビルド、公開手順の設計基準です。

  • ASSET_RULES.md 図版や画像などのアセット管理ルールです。

  • EDITORIAL_WORKFLOW.md 企画から改訂までの標準フローです。

  • CONTEXT_MANAGEMENT.md 長期作業で /compact を実行するタイミングと、実行前に Markdown へ残すべき情報をまとめています。

  • AI_MODEL_POLICY.md 企画、執筆、レビューで AI を利用するときのモデル選択と、公開前の確認方針をまとめています。

  • CI_RULES.md 書籍リポジトリで CI に何を持たせるべきかの基準です。

  • PROMOTION_POLICY.md FjordBootCamp の紹介文、掲載位置、各ページ共通フッターの扱いをまとめた方針です。

  • THEME_CUSTOMIZATION.md theme/ 配下の CSS/JS、特に textbook-footer.js の役割と運用ルールです。

使い方

新しい書籍を作るとき

  1. 執筆者には WRITING_PROMPT.md を最初に渡す(以降の手順を1枚にまとめてある)
  2. STYLE_GUIDE.md特に第0節「良い章と悪い章の違い」 を読む。SAMPLE_CHAPTER.md(密度のゴールドスタンダード)も先に読む。AI を利用する場合は AI_MODEL_POLICY.md も確認する
  3. BOOK_OUTLINE_TEMPLATE.md章ごとの議論(主張・具体例・誤解)を OUTLINE に書き起こす。ここを飛ばすと章が薄くなる
  4. その書籍リポジトリ側に STYLEGUIDE.md を作り、バージョン前提・用語統一表・基準 URL を具体的に固める(既刊 Hotwire / Tailwind が手本)。あわせて共有テーマ mdbook-book-jpbin/install.sh で導入する(THEME_CUSTOMIZATION.md)
  5. TERMS.md に、その書籍で必要な用語統一を追加する
  6. CHAPTER_TEMPLATE.md の「章を書く前に答えること」に答えてから本文を書く(テンプレートの穴埋めをしない)
  7. 原稿を書いたら REVIEW_CHECKLIST.mdまず「密度・固有性チェック」 で自己点検する

中核の教訓: 形(見出し・節・参考資料)を揃えても良い本にはならない。密度(具体例・対比・根拠・体系的接続) を揃える。詳細は STYLE_GUIDE.md 第0節。

編集レビューするとき

  • 好みではなく REVIEW_CHECKLIST.md の基準で見る
  • 文体の揺れ、説明順の崩れ、参考資料不足、図版の役割過多を優先して直す
  • シリーズ全体の整合性は STYLE_GUIDE.md を基準に判断する

このリポジトリの考え方

FBC Press は、単なる技術解説やクラス一覧、API リファレンスを作るためのシリーズではありません。
背景、思想、仕組み、実務判断を一続きで説明し、読者が暗記ではなく判断できる状態になることを重視します。

そのため、このリポジトリの文書も「便利なテンプレート集」では終わらせず、次を揃えることを目的にしています。

  • 文体の一貫性
  • 説明順の一貫性
  • 用語の一貫性
  • レビュー基準の一貫性
  • シリーズ全体の価値観の一貫性

今後の運用

必要になったら、このリポジトリにさらに次を追加して育てていきます。

  • 実在書籍ごとの個別スタイルガイド
  • 書籍ジャンル別の注意点
  • 図版サンプル集
  • 参考資料の実例集
  • 章レビューの記録テンプレート
  • 改訂履歴テンプレート
  • 書籍ごとの公開チェックリスト
  • theme 用のサンプル実装集

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors