majiayu000 Structured Writing
概要
文書をトピック単位に分割し、再利用可能な構造で設計・検証するスキル。目的と読者に合わせて情報を整理し、保守性を高める。
詳細は references/Level1_basics.md から段階的に参照する。
ワークフロー
Phase 1: 目的と読者の整理
目的: 文書の目的・読者・利用シーンを明確化する。
アクション:
- 利用目的（学習/運用/仕様参照）を整理する。
- 読者の経験レベルを定義する。
- トピック種別（Concept/Task/Reference）を決める。
Phase 2: トピック構造設計
目的: 文書構造と再利用単位を設計する。
アクション:
assets/topic-map-template.mdで全体構造を作成する。- トピックテンプレートを選定する。
- 再利用・分割のルールを決める。
Phase 3: 検証と改善
目的: トピック構造の整合性を検証する。
アクション:
scripts/validate-topic-structure.mjsで必須見出しを確認する。scripts/analyze-structure.mjsで全体構造を分析する。- 指摘を反映して文書を更新する。
Task仕様ナビ
| Phase | Task | 目的 | 入力 | 出力 |
|---|---|---|---|---|
| 1 | 目的・読者整理 | 目的/読者/トピック種別を定義 | ユーザー要求 | 要件メモ |
| 2 | トピック設計 | トピック構造と再利用単位を設計 | 要件メモ | トピック設計書 |
| 3 | 構造検証 | トピックの整合性を検証 | 文書セット | 検証レポート |
ベストプラクティス
すべきこと
- トピック種別ごとに役割を明確に分離する。
- 再利用単位を先に設計してから執筆する。
- 見出し順序を統一する。
- テンプレートで品質を均一化する。
避けるべきこと
- 1トピックに複数の目的を詰め込まない。
- 手順と概念を混在させない。
- 再利用の前提を持たずに長文化しない。
リソース/スクリプト参照
references/
references/Level1_basics.md: 基礎指針references/Level2_intermediate.md: 実務パターンreferences/Level3_advanced.md: 高度な設計指針references/Level4_expert.md: 専門領域の注意点references/dita-principles.md: DITA原則references/dita-topic-model.md: DITAトピックモデルreferences/topic-types.md: トピック種別ガイドreferences/section-ordering.md: 見出し順序references/reuse-strategies.md: 再利用戦略references/content-reuse.md: コンテンツ再利用references/modular-design.md: モジュール設計references/information-architecture.md: 情報設計
assets/
assets/topic-map-template.md: トピックマップテンプレートassets/concept-topic-template.md: Conceptテンプレートassets/task-topic-template.md: Taskテンプレートassets/reference-topic-template.md: Referenceテンプレートassets/concept-topic.md: Concept例assets/task-topic.md: Task例assets/reference-topic.md: Reference例
scripts/
scripts/validate-topic-structure.mjs: トピック構造検証scripts/analyze-structure.mjs: 文書構造分析
変更履歴
| Version | Date | Changes |
|---|---|---|
| 2.0.0 | 2026-01-02 | 18-skills.md 仕様に準拠した構造へ更新 |