Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 1.73 KB

File metadata and controls

49 lines (39 loc) · 1.73 KB

技術ノート運用ルール

目的

  • 技術的な疑問を、あとで読み返せる静的 HTML 記事として残す
  • 1テーマ1ページで articles/ に蓄積する
  • index.html から新着とカテゴリの両方で辿れるようにする

記事生成ルール

  • ユーザーが 質問: で始めた依頼は、記事化タスクとして扱う
  • 出力先は articles/<slug>.html とする
  • 各記事には以下を含める
    • タイトル
    • 要点
    • 本文
    • 比較や図解に相当する要素
    • 参考URL
    • 作成日
  • HTML は単体で読める形にし、共通スタイルは styles/site.css を使う
  • 記事ごとに最低1つは図を入れる
  • 図は装飾ではなく、流れ、比較、構造の理解を早めるために使う
  • 図解が必要なら、まずは HTML と CSS だけで表現し、必要時は inline SVG を優先する

一次情報と安全性

  • 参考URLは必ず末尾に付ける
  • 仕様、価格、法令、リリース状況など変化しやすい情報は一次情報を優先する
  • 秘匿情報、認証情報、個人情報は記事に含めない
  • 公開前に差分を人間が確認する

トップページ更新ルール

  • 新しい記事を追加したら index.html も更新する
  • 最低限、以下の両方を更新する
    • 新着セクション
    • 対応カテゴリのセクション
  • カードには以下を含める
    • 日付
    • 小分類
    • タイトル
    • 1文要約
    • 補助メタ情報

GitHub Pages 想定

  • このリポジトリはビルド不要の静的サイトとして運用する
  • 配信対象は HTML、CSS、画像など公開前提のファイルに限る
  • 機密につながる JSON、YAML、env は置かない