開発者のためのテクニカルライティング十戒

<p>- 必須の文の構成要素を省略しない<br /> - 文の構成要素の対応関係を保つ<br /> - 助詞を正しく使う<br /> - 受け身形・使役形を避ける<br /> - 二重否定を避ける<br /> - 明確な表現を使う<br /> - 順序と一覧を区別する<br /> - 箇条書きを活用する<br /> - 正書法・分かち書きをチェックする<br /> - 外来語表記をチェックする</p>

[xguru]

<p>- テクニカルライティングの4大原則 https://ja.news.hada.io/topic?id=5409<br /> - 推敲の技術 - 開発者の技術文書作成法 https://ja.news.hada.io/topic?id=5446</p&gt;

[hongminhee]

<p>プログラマーの場合、外来語表記法は事実上英語だけ気にすればよいのですが、韓国語の外来語表記法はつづりではなく実際の発音を基準にする点、そして英語はつづりが発音を正確に反映していないため、単語のスペルではなく発音記号を見て移すという点を念頭に置くと、ミスが少なくなります。<br /> <br /> よく分からなければ、1) 国語辞典でその英単語をそのまま引いて載っていればそれを使い、2) 載っていなければ英語辞典でその単語を調べて国際音声記号（IPA）を見て表記を推測すればよいです。ただし、外来語表記法の規定は英語についてはイギリス式発音を手本にしているため、意外な表記になることも少なくありません。<br /> <br /> 英語でなければ、ハングライズ（https://hangulize.org/）のようなものを使うと便利ですが…;