執筆フロー
このドキュメントは、記事の下書きから公開までの一連のフローをまとめたものです。
フロー概要
/doc/（Docusaurus）で記事の下書きを書く- 機密情報を確認・除去する
/l-convert-to-articleスキルで下書きをブログ用MDXに変換する- タグを付与する
- 外部リンクを付与する
- コミット・プッシュして公開
1. 下書きを書く
/doc/docs/articles/ 配下にMarkdownファイルを作成し、記事の下書きを書く。
Docusaurusの執筆支援コマンドが使える。
/l-text-polish- 雑なテキストをルールに沿った文章に整形/l-text-expand-story- 箇条書きやメモから話を膨らませて文章化/l-text-fix-typos- タイポや表現の問題を修正/l-text-rephrase- より良い言い回しを提案/l-text-review-article- 3つのサブエージェントで記事をレビュー
下書きの段階ではDocusaurusのアドモニション記法（:::note、:::info）をそのまま使って良い。変換時に自動的にブログ用のコンポーネントに置き換わる。
2. 機密情報の確認
変換前に、下書きにクライアント案件由来の機密情報が含まれていないか確認する。
- クライアント名・企業名を削除または汎用的なプレースホルダーに置き換える
- プロジェクト固有のファイル名・変数名を汎用的な名前に変更する
- 社内 URL・ステージング URL を除去する
詳細は機密情報のルールを参照。/purge-private-info コマンドで自動スキャンも可能。
3. 記事に変換する
下書きが完成したら、/l-convert-to-article スキルを実行する。
このスキルは以下を行う。
- Docusaurusの下書きMarkdownを読み取る
- ブログ用のMDXフロントマター（
title、description、author、createdAt）を設定する - Docusaurusのアドモニション記法をブログ用コンポーネントに変換する
:::note 注記→<Note>:::info 備考→<Info>
- 変換したMDXファイルを
/blog/src/articles/に保存する
4. タグを付与する
変換後、タグ関連のスキルを使って記事にタグを付ける。
/l-tag-attach-to-article- 記事の内容に基づいて適切なタグを提案・付与する/l-tag-update-list- 必要に応じてタグ一覧を更新する
タグのルールについてはタグ一覧を参照。
5. 外部リンクを付与する
タグ付与後、記事中のキーワードに外部リンクを付ける。
/l-make-link-plan- 記事からリンク候補のキーワードを抽出し、外部URLを検索して付与する
フレームワーク名、ライブラリ名、ツール名、API名など、公式サイトやドキュメントへのリンクがあると読者にとって便利なキーワードが対象。各キーワードの初出箇所にのみリンクを付ける。
6. 公開する
コミットしてプッシュすると、本番サイトにデプロイされる。