タグ

関連タグで絞り込む (0)

  • 関連タグはありません

タグの絞り込みを解除

qiitaとwritingとdocumentに関するyuki_2021のブックマーク (2)

  • 伝わる文章作成の基本を学ぶための記事・学習コンテンツのまとめ - Qiita

    短いメッセージを書くことはできても、まとまった文章を書くのに苦労している人は多いのではないでしょうか。 この記事では、まとまった文章を作るときの技術を学ぶことができる記事や学習コンテンツを紹介します。新人エンジニア向けです。 文章の「型」を学ぶ まとまった文章を書くには、「型」が必要です。頻繁に使うものは、「型」を覚えてしまいしましょう。 バグレポートの書き方を学ぶ エンジニアとして書く文章の代表例が、バグレポートです。 バグレポートでありがちな失敗として「何が問題だと思っているのか」が伝わらないというものがあります。 これを防ぐために、「期待する結果」「実際の結果」「再現手順」の3つを必ず書くようにしましょう。 質問の書き方を学ぶ エンジニアが扱う技術は、最初はわからないことだらけです。 それを解決するために、質問の文章を作成する技術が必要となります。 概ね下記の4つの情報があれば、良い

    伝わる文章作成の基本を学ぶための記事・学習コンテンツのまとめ - Qiita
  • 実践テクニカルライティング - 開発者が「外国語」を使うときの言語技術達3つ - Qiita

    言語技術 というものをご存知でしょうか。 言語技術とは、思考を論理的に組み立て、相手が理解できる様に分かりやすく表現すること。 人前で話す能力や議論の能力、文章を書く能力や論文を書く能力はトレーニングによって身につけられる。我々開発者にとっても、普段の語彙に距離のある相手、たとえば非技術者との会話の際にこの言語技術を意識することがキーになる。記事のタイトルは「外国語」と書いたが、英語は勿論、開発者にとって顧客や非技術者は時として「外国人」。開発者にとって、例えば 英語学習 テクニカルサポートのやり取り の時等に使える、情報を整理する言語技術とツールについて、3つのトピックからまとめた。 『外国語を身につけるための日語レッスン』に学ぶ、言語技術 『情報を整理するたった5つの方法 LATCH』 Google Sheets 等で、「外国語」を使う相手と状況共有をうまくする仕掛け 1. 『外国語

    実践テクニカルライティング - 開発者が「外国語」を使うときの言語技術達3つ - Qiita
  • 1