記事の執筆規約

#

frontmatter

#

TOML (+++) で統一する。 YAML の --- は本文中の水平線と衝突する。

+++
title = ""
date = ""
draft = true          # 公開時のみユーザーが false にする
categories = []       # 1〜2個
tags = []             # 3〜6個
summary = ""          # 記事一覧カードの要約。80字前後
description = ""      # <meta name="description">。120〜160字
ads = true            # 広告の有無。カテゴリではなくこの値で制御
corp_link = false     # コーポレートサイトからリンクする対象か
+++

summary と description は役割が違う。summary は一覧カード、 description は検索結果に出るメタ情報。両方書く。

posts/ は ads = true、notes/ は ads = false が既定。 1本の記事が「思想」「技術力の証明」「製品告知」を兼ねることがあるため、 広告の有無をカテゴリで決めない。

既存記事をリライトする場合、date は初出の日付を保持し、 lastmod に改稿日を入れる。

記事の型

#

docs/style.md を読むこと。

技術記事は「理論 → 実測 → 検証 → 定石が有効な理由」まで到達させる。 定石を「そういうものだ」で終わらせない。導出する。

画像

#

• 記事と同じディレクトリに置く（ページバンドル）
• アイキャッチは featured.svg または featured.jpg
• alt テキストを必ず書く
• 写真は EXIF を全削除してから置く。 施主宅・店舗の GPS 座標が埋まっている
• SVG は Inkscape / Illustrator のメタデータ（作成者名、ローカルパス）を削除する
• 本文中に H1 を使わない（title が H1）

禁止

#

• 技術的な内容を、ユーザーの確認なしに書き換えない
• 顧客名・未公開の型番・レジスタマップ・施主情報を書かない
• draft の値を変更しない
• スラッグ（ディレクトリ名）を後から変更しない