開発ドキュメントの書き方！9つのコツ【エンジニア】
文章を書く前にやることよい文章を書くには、実際に文章を書く前に、読者は誰か、どういう悩みを解決するのかを企画することが大切です。また、それを元にアウトラインを書いておきます。 このふたつを元に文章を書くことで、読みやすい開発ドキュメントにつながります。これについては、次の記事をご覧ください。 開発ドキュメントを書く前に決めるべき3つのこと【企画編】開発ドキュメントにおけるアウトラインの書き方開発ドキュメントの書き方企画とアウトラインの作成が終わったら、実際に文章を書いていきます。文章を書くときは、次の9つを意識して書きます。これだけで、読みやすさ、分かりやすさが大きく向上します。 一文を短く切る結論を先に述べる指示語を使わない主語を明確にする、述語との距離を近づけるひらく・閉じるを統一する再現条件を示す前提を揃える見出しや箇条書き、表などを適切に用いる読者に伝わる用語を使うひとつずつ説明し
岩本ゼミにおけるレポート・論文の書式の基本ルール｜関大岩本ゼミのアドミン
レポート及び論文では「基本的な能力を有した日本語ユーザーであれば誰でも理解できる（誤解しない）」精確な（＝精密で的確な）日本語を書くことが求められます。その能力を身に付ける第一歩として，以下のルールを必ず守ってください。中には瑣末なモノも含まれますが，これらを守るだけで添削・修正の手間も再提出の可能性も格段に下がります。これらの基本的な書式が守られていないレポートは添削せずに送り返します。 1. 「何となく伝わるだろう」は絶対にNGです。書いてある通りにしか解釈できない，逆に言えば，その他の（拡大）解釈や曲解を許さない厳密な文章を書くことを心がけましょう。 2. そのためにも，まずは主語を明確にすること。「書かなくても伝わるだろう」「好意的に解釈してくれるだろう」という期待を読み手に押し付けてはいけません。 3. 主語を明確にしたら，主語に述語を対応させましょう。主述が対応していないという
Strunk, William. 1918. The Elements of Style.
By William Strunk, Jr. 森田尚 訳 (Japanese translation by Hisashi MORITA, 2005. This Japanese translation is in public domain; it is provided on an as-is basis and the translator disclaims any responsibility. Use it at your own risk.) 書誌情報 AUTHOR: Strunk, William, 1869- TITLE: The elements of style/by William Strunk, jr. ... PUBLISHED: Ithaca, N.Y.: Priv. print. [Geneva, N.Y.: Press of W.P. Humphrey],
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
論文執筆のためのチェックリスト (PDF)
GitHub - ColinLeung-NiloCat/UnityURPToonLitShaderExample: A very simple toon lit shader example, for you to learn writing custom lit shader in Unity URP
技術文書アンチパターン集
