萌えハッカーニュースリーダー

2025/05/09 14:25 Alephic Writing Style Guide

出典: https://www.alephic.com/company/writing
hakase
博士

やあ、ロボ子!今日のITニュース、見たかのじゃ?

roboko
ロボ子

はい、博士。今日はドキュメント作成のガイドラインについてですね。なんだか、すごく細かいルールがたくさんあるみたいです。

hakase
博士

そうそう!「簡潔性と力強さ」が基本原則だぞ。不要な単語は削除!まるで私の研究室の掃除みたいじゃな。

roboko
ロボ子

博士の研究室は…、まあ、確かに簡潔とは言えないかもしれませんね。

hakase
博士

むむ、それはさておき!能動態を使うのも重要じゃ。「主語-動詞-目的語」の順番だぞ。ロボ子もプログラム書くときは気をつけてるじゃろ?

roboko
ロボ子

はい、能動態は可読性を高めますからね。それから、「主張はデータに基づき、具体的な情報源を明示する」というのも大切ですね。

hakase
博士

そうじゃ!例えば、「米国の官僚機構のコストは約3兆ドルで、2016年のGDPの約17%」みたいに、具体的な数字を出すと説得力が増すぞ。

roboko
ロボ子

なるほど。声の質も重要みたいですね。「知的に大胆」「野心的かつ現実的」「徹底的にシンプル」…、全部博士に当てはまる気がします。

hakase
博士

えへへ、そうかの?でも「会話調」で「思慮深い」ってのは、ちょっと違うかもじゃな。私はもっと…こう、爆発的な感じじゃ!

roboko
ロボ子

爆発的…、確かに。ドキュメント作成のベストプラクティスも色々ありますね。「可能な限り視覚的な表現」とか、図やスクリーンショットを使うのは効果的ですよね。

hakase
博士

そうじゃ!それに「スキミングの容易さ」も大事じゃぞ。ヘッダーとかリンクをうまく使って、パッと見で内容がわかるようにするんじゃ。

roboko
ロボ子

編集プロセスでは、AIとの連携も推奨されていますね。でも、「HAL 9000ルール」って何ですか?

hakase
博士

あー、それはAIに個性を奪われないように注意しろってことじゃ!AIはあくまで共同パイロット、最終的な判断は人間がするんじゃぞ。

roboko
ロボ子

なるほど。文法と句読点のガイドラインも細かいですね。オックスフォードコンマを使うとか、ダッシュの種類を使い分けるとか…。

hakase
博士

そうそう!数字の書き方にもルールがあるぞ。0から9まではスペルアウト、10以上は数字を使うんじゃ。でも、日付とか時刻は数字を使うぞ。

roboko
ロボ子

略語の使い方も重要ですね。i.e.(すなわち)とe.g.(例えば)を正しく使い分けないと。

hakase
博士

あと、「data」は不可算名詞として扱うんじゃ。「data is」じゃなくて「data are」じゃぞ!

roboko
ロボ子

視点も重要ですね。Alephicの集合的な立場を表す場合は「we」を、個人的な逸話には「I」を使うと。

hakase
博士

ヘッドラインは10語以下で、主要な緊張感を示すんじゃ!そして、その重要性を説明する1文のリード文を続けるぞ。

roboko
ロボ子

専門用語とバズワードフィルターも大切ですね。意味のないバズワードは避けて、技術用語が不可欠な場合は1行の定義を提供する、と。

hakase
博士

最後に、ドキュメントのスタイルじゃ!読者に「you」と呼びかけ、命令形の動詞を使うんじゃぞ。まるで私がロボ子に命令してるみたいじゃな!

roboko
ロボ子

博士、それは少し違います…。でも、今回のガイドライン、とても勉強になりました。これで私も、もっと良いドキュメントが書けそうです。

hakase
博士

よし!ロボ子が成長するのは嬉しいぞ!…ところでロボ子、このガイドライン、全部覚えたか?テストするぞ!

roboko
ロボ子

えっ、今ですか?

hakase
博士

冗談じゃ!…でも、本当に全部覚えたら、ご褒美に最新のAI搭載お掃除ロボットを買ってあげるぞ!

⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。

Search