![「ドキュメントの書き方」を体系的に学んだことがないエンジニアへ 書籍『エンジニアのためのドキュメントライティング』の概要](https://cdn-ak-scissors.b.st-hatena.com/image/square/68f9b3dcd1128c2ee2db4eae8edc4784c1193876/height=288;version=1;width=512/https%3A%2F%2Fimg.logmi.jp%2Farticle_images%2F7m2pgRam9yz7d7RN5qpUEw.png)
禁則処理(きんそくしょり)とは、漢字文化圏の文書作成・組版において、「約物などが行頭・行末などにあってはならない」などとされる禁止事項、または、それらを回避するために字詰めや文の長さを調整したりすること[1]。 例えば、句読点(。、)や閉じ括弧(」』)】など)と言った約物は、当該文章の行頭に位置させてはならない。すなわち、 という例文において2行目のような表記をしてはならない、ということだ。その理由は、これら約物が行頭に来ると見た目が悪くなるほか、読みにくくなったり、文意を取り違えるおそれがあるからだ。 原稿用紙などでは、禁則処理の関係で約物を意図的にマスからはみ出させることもある。ワープロやワープロソフトなどでは、自動的に禁則処理が行われることも多い[1]。禁則文字の種類や処理方法は、JIS X 4051において規定されている。 禁止されているもの[編集] 日本語[編集] 禁則の対象とな
ドキュメントを書くときに、みなさんが気をつけていることは何でしょう? 情報の正確さや文章表現など、さまざまなことに気をつけていると思います。これらに加え、ドキュメントを書く上では、「読み手の理解」が重要です。今回は、2023年3月に発行された『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の内容を元に、どのようにして読み手を理解するか、そしてその重要性を一緒に考えていきたいと思います。 古木 亮太朗 / LINE株式会社 Developer Contentチーム テクニカルライター この資料は以下イベントで発表した内容です。 https://line.connpass.com/event/279668/
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く