このクラスでは、テクニカルエッセイライティングの芸術を練習する多くの機会を提供します。 ここでは、一般的な問題を回避するために使用できるいくつかの簡単なガイドラインがあります。
小論文ファイルには、件名(日付ではない)に応じて名前を付けます。
techfolioテンプレートエッセイファイルは、作成された日付で名前が付けられています（つまり2015-08-26.md).これをしてはいけない:主題を反映するために各エッセイファイルに名前を付けなさい。 たとえば、ファイル名をエッセイのタイトルに基づいて設定することができます。 あなたのエッセイのタイトルが”火を点火する”の場合、あなたのファイル名は”igniting-the-fire.md”.
ファイル名にスペースを含めないでください：使用”igniting-the-fire.md”ではなく、”fire.md”.
ブラウザがファイルを表示するのではなくダウンロードしている場合、それはおそらくファイル名が”.md”で終わらないためです。
エッセイに関連するURLが読みやすく、その主題の表示を提供するために、正しい命名が重要です。
ファイル名の一部として”reflect”または”reflections”を使用しないでください。
読者を引き込む興味深いタイトルを作成します。
モジュール名(“Configuration Management”)やエクスペリエンス名(“Reflections on Javascript”)でエッセイに名前を付けないでください。 検索エンジンは、多くの場合、ページのタイトルを強調しています。 そのようなタイトルに基づいてエッセイを読みたいと思うか。 少し考えてみると、個人的なもの（つまり、「私の仕事をほとんど犠牲にした構成管理の大惨事」）や巧妙なもの（「あなたが望むものを常にgitすることはで
“reflect”や”reflections”をタイトルの一部として使用しないでください。
適切なスペルと文法を使用する
単語のスペルを間違えないでください。 適切な文法を使用してください。 あなたが自信を持っていない場合は、出版前にスペルや文法をチェックするためのオンラインツールを利用してください。
教授ではなく、世界のために書く
あなたのエッセイの多くは、家庭の課題をしているあなたの経験（すなわち経験）に基づいていますが、割り当てを説明 プロンプトからの”質問”のそれぞれに答えるためにセクションを作成してはいけない。 あなたがそれを行う場合は、ほぼ確実に読むことは興味深いではない退屈なエッセイを作成します。
代わりに、”世界のために”と書いてください。 いくつかのランダムな技術的な専門家がグーグルされており、あなたのエッセイが出てきたと仮定します。 その任意専門家にエッセイをはめ込み式、自明、有用にさせなさい。 あなたがその人のソフトウェア工学の背景について作る仮定を最小にしなさい(このクラスの大いにより少ない背景!）有用であれば、背景素材へのリンクを提供します。
さまざまな人のために書くだけでなく、さまざまな時間のために書くべきです。 言い換えれば、誰かが一年でそれを読んだ場合、それはまだ価値のある情報を提供するようにあなたのエッセイを書くようにしてください。 あなたが主題の初心者であれば、それを書いて、他の初心者に洞察と理解を提供してください。
エッセイを説得力のあるものにするには、通常、”物語を伝える”ことが役立ちます。 物語を作成し、質問に答えるだけではありません。
コードを適切にフォーマット
コードが投稿に正しく表示されていることを確認してください。 これを実現するには、フェンスで囲まれたコードブロックと構文の強調表示を使用します。 Javascriptコードの強調表示の例を次に示します:
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}大きなコードスニペット（50行を超える）を含める前に慎重に検討してください。 経験則として、コードスニペットを妥当な長さに保ち、すべてのコードがエッセイの主題に直接関連していることを確認してください。
あなたのエッセイを構造化するために内部見出しを使用
良いエッセイは、内部構造のいくつかの並べ替えを持っています。 内部見出しを提供することで、読者がこの構造を理解するのを助けます。 あなたの投稿のタイトルのために予約されているので、H1（つまりMarkdownの#）で始まらないでください。 代わりに、H2（markdownでは##）で開始し、そのセクション内にh3（markdownでは###）などでサブセクションを作成します。
同様に、項目別または列挙型のリスト、テーブルなどを必要に応じて使用します。
書式と属性の引用
テクニカルエッセイで別の作家を引用したいことがあります。 あなたがそれらの言葉をあなた自身のものとして提示しない限り、これは大丈夫です。
単一または二つの文を引用する場合は、単に斜体、引用符を使用し、著者の名前を提供することができます。 たとえば、
Steve Jobsが指摘したように、”デザインは見た目だけではなく、感じているものでもありません。 デザインは、それがどのように動作するかです。”
長い引用符の場合は、<blockquote>環境を<フッター>とともに使用します。 たとえば、
冷笑的な若者は、何も知らないことから何も信じないことになったことを意味するので、見るのが最も悲しい光景です。
写真や他のメディアを含める
彼らが言うように、”絵は千の言葉の価値があります。”あなたのエッセイに写真やビデオを含めることは非常に簡単です。 あなたのエッセイの意味が画像でより明確に伝えられる場合は、時間をかけて見つけて含めるようにしてください。 画像やビデオを含める方法については、TechFolioユーザーガイドの書式設定セクションを参照してください。
退屈なことはない、不適切なことはない
エッセイは本質的に技術的であるからといって、退屈である必要はありません。 あなたの執筆にあなたの人格を注入することを試みなさい。 あなたは”賢い”タイトル、ポップカルチャーの参照などを持つことができます。
一方、賢さに乗って船外に行かないでください。 あなた自身に尋ねなさい:私の母がこのエッセイを読めば私は当惑するか。 （彼女はかもしれないので。）潜在的な雇用者がこのエッセイを読めば私は当惑するか。 （彼女はかもしれないので。)
目標は、創造的であること、いくつかの個性を示すこと、そしてエッセイを読むのが楽しく、有益なものにすることです。
最後に書かないでください
次のようにそれらを開発すると、あなたのエッセイの質は大幅に上昇します:
- 最初の草案を書く。
- 4時間何か他のことをしてください。
- 戻ってきて、最初の下書きの上に編集パスを行います。
編集パスは、通常、多くの問題をキャッチし、あなた自身が”新鮮な目”でそれを見ることができるように十分な時間のためにエッセイから離れて歩んだ限り、あなたの考えを大幅に洗練することができます。 それを行うための最良の方法は、一晩それで寝ることですが、あなたはその多くの時間を持っていない場合は、少なくとも数時間別の何かをします。 これはあなたの潜在意識が材料に取り組むことを行くことを可能にする。
投稿の内容と外観を確認する
投稿を作成して公開したら、ブラウザで取得して外観を確認します。
一つの段落では十分ではありません
いくつかの部分的な信用を得ることを期待して二、三文のエッセイを書くことは良い戦略ではありません。 一つには、そのようなエッセイは、すべてのエッセイよりもあなたのプロのペルソナに多くの悪い反映していません。 別のもののために、我々は非常に少ない努力を反映してエッセイのためのゼロポイントを授与する傾向があります。
UH Manoa Writing Centerを利用する
UHM Writing Centerは、執筆プロセスのすべての段階で支援するように訓練されたコンサルタントを提供しています。
週に二つの予定だけでなく、週に三つのウォークインアポイントまでスケジュールすることができます。