章執筆スキル
使い方
- •
/book-write <章番号>- 指定した章を執筆 - •
/book-write 01- 第1章を執筆 - •
/book-write all- 全章を順番に執筆
対象
$ARGUMENTS
入出力
- •入力:
src/toc.md(詳細化済み目次) - •出力:
src/chapters/XX-slug.md(章ファイル)
前提条件
- •
/book-detailで目次が詳細化されていること - •各セクションに「書くべきポイント」「参考資料」が記載されていること
処理手順
- •
src/toc.mdから該当章の詳細情報を読み込む - •「書くべきポイント」に従って本文を執筆する
- •「参考資料」のknowledgesを適宜参照・引用する
- •
src/chapters/XX-slug.mdに本文を出力する - •Publisherに公開を依頼する(GitHub Pages)
注意:
- •調査は不要(既にknowledgesに蓄積されている)
- •lintチェックは夜間バッチ処理で行う(執筆時は不要)
執筆ガイドライン
文体
- •ですます調で統一する
- •句点(。)で文を終える
- •読点(、)は1文に3個以内
- •1文は150文字以内
構成
- •各セクションの冒頭で概要を説明する
- •具体例を交えて説明する
- •必要に応じてコード例を挿入する
- •セクション末で要点をまとめる
参照
- •knowledgesの情報を適切に引用する
- •出典がある場合は明記する
- •画像を使う場合は
images/を参照する
ファイル命名規則
text
src/chapters/XX-slug.md
- •XX:2桁の章番号(01, 02, ...)
- •slug:章の英語名(小文字、ハイフン区切り)
例:
- •
src/chapters/01-introduction.md - •
src/chapters/02-basics.md - •
src/chapters/03-advanced.md
出力例
src/chapters/01-introduction.md:
markdown
# 第1章 はじめに 本章では、本書の目的と対象読者について説明します。 ## 1.1 本書の目的 本書は〜を目的としています。 ### なぜこの本を書いたのか 筆者が〜に取り組む中で、〜という課題に直面しました。 ## 1.2 対象読者 本書は以下のような読者を想定しています。 - 〜の経験がある方 - 〜に興味がある方
注意事項
- •執筆後はすぐにGitHub Pagesに公開する
- •lintチェックは夜間バッチ処理で行う(執筆時は不要)
- •画像は
images/章番号-名前.png形式で参照する - •コードブロックには言語を指定する
ワークフロー
code
執筆完了 → GitHub Pages公開 → 人間レビュー
↓
夜間バッチ処理
(lint、改善)