Skip to content

Latest commit

 

History

History
96 lines (78 loc) · 4.29 KB

File metadata and controls

96 lines (78 loc) · 4.29 KB

このリポジトリで書くときの決まり

言葉づかい — これが一番よく破られる

2026-08-08 から4回指摘されている。普通の言葉で書く。

発注者の言葉: 「日本のプログラマーは絶滅するから真似をしないで」(2026-08-17)

使わない言葉

使わない 使う
台本 スクリプト
門番 チェック、検査
便(作業の1回分の意味) 回、作業
的(ターゲットの意味) 対象、対象 OS
物差し 基準、確認方法
畳む 閉じる、削除する
素の 普通の、元の
口(API・ソケットの意味) API、ソケット、入り口
橋(プロセス間の接続の意味) 接続、〜を操る仕組み
互換層、ラッパー
正本 / 副 元、原本 / 訳
束縛 変数
語彙 書き方
着せる 使う
実測 実際に動かして確かめた
組み手 / 折り手 レイアウト処理
巻物 連続表示
名乗り 宣言
釦 / 板 / 檻 / 錨 / 糸 ボタン / パネル / サンドボックス / アンカー / スレッド
生成器 / 家訓 生成スクリプト / 方針
殻(アプリの意味) アプリ、本体
耳(タブの意味) タブ、シート見出し
升 / 升目 セル
(使わない — 普通の説明文で書く)
面(画面の意味) 画面、編集画面
枠 / 器(仕組みの意味) 仕組み、一覧
鍵(設定やキーボードの意味) キー(暗号の鍵・公開鍵はそのまま)
札(ボタンやタブの文字の意味) ラベル、表示名
かぶり / 重なり 重複
持ち場 受け持ち、担当、「〜が処理する」
裏方 / 裏で呼ぶ 内部の処理、「〜が処理する」
車線 作業の流れ、別の作業
踏み跡 分かったこと、経緯

表に無い言葉でも、「普通そう言うか」で判断する。迷ったら Excel や Word のヘルプが使う言葉を選ぶ。

書き方

やめること:

  • 造語や比喩で言い換える
  • 格言のように言い切る(「〜は〜より悪い」「〜が筋」)
  • 太字を並べる(1段落に多くて1つ)
  • 体言止めやダッシュ(—)でつないで、主語と述語をあいまいにする
  • 1つの文に複数のことを詰める

書くこと:

  • 主語と述語をそろえた普通の説明文
  • 1つの文には1つのこと
  • 専門用語は一般に通じるカタカナ語
  • 説明は「です・ます」

これは文書だけでなく、画面の文言・発注者への返答にも効く。書いた後に 「普通の人が読んで分かるか」を1度見直す。

コミットメッセージは英語で書きます(2026-08-30 発注者)。上の言葉の 決めは日本語の文に掛かるもので、コミットには掛かりません。英語でも 「1文1事」「言い切らない」「太字を並べない」は同じです。

機械の検査もある。python3 tools/kotoba_check.py

利用者向けの文書は、さらに厳しい

  1. Excel / Word の公式用語で書く。 利用者はヘルプで覚えた言葉で探す。 式 → 数式、真偽 → 論理値、様式(docx)→ スタイル、入力規則 → データの入力規則
  2. 内輪の日付や決定の注記を入れない。 「(2026-08-09 発注者確定)」の 類は設計文書のものです。

作業の進め方

  • push は発注者がします。 コミットまでで止めてください
  • ワークツリーは使いません。 ~/dev/officework で直接作業します
  • コミットは自分が触ったファイルだけを名前で指定して1回で行います (git add <paths> && git commit -m "…" -- <paths>)。 git の index は他のセッションと共有しているためです
  • 秘密の値(API キーなど)は画面に出しません。あるかどうかだけ確かめます
  • 画面を直したら、実際に動かして見てから報告します。 テストが通った だけでは報告しません
  • エンジンの共有の型(kumihan::Paragraph など)を触ったら、 cargo check --workspace --all-targets を1回(20秒)。 「全部のテストは回さない」とは別の話です