LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた
LINE株式会社は、2023年10月1日にLINEヤフー株式会社になりました。LINEヤフー株式会社の新しいブログはこちらです。 LINEヤフー Tech Blog こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。今日は、私が1文を書くときに気をつけていることや手法についてお話しします。 そして、この書き出しは、6月にmochikoさんが書いた「LINEの社内には「テクニカルライティング」の専門チームがあります」という記事のオマージュになっています。mochikoさんが書いた記事ですごいpvをたたき出したそうなので、人のふんどしで相撲を取ってみようという作戦で始めてみました。 この記事ではLINE社内で私が講師を務めた「LINE社内で大評判のテクニカルライティング講座」に沿って、わかりやすい1文を書くコツを紹介していま
エンジニア歴20数年の私が、設計書を書く際に心がけていること - Qiita
はじめに 時の経つのは早いもので、私がIT業界に身を置いて四半世紀になってしまいました。 その間、膨大な数の「設計書（仕様書）」を書いて来ましたが、未だに悩み・迷いは尽きません。 それでも、亀の甲より年の劫とも申しますので、私なりの経験則を「個人」と「チーム」の両観点でまとめてみました。 本稿のテーマは、「主に設計書を想定した、開発ドキュメントの書き方」です。 本稿で前提とする設計書は、ExcelやWordで書かれた、フォーマルな（≒納品物になりえる）設計文書、です。 したがって、自社サービス開発よりも受託開発、アジャイルよりもウォーターフォール、を前提として読んでいただいた方が、しっくりくると思われます。 ＜ご注意＞ 本稿の内容は執筆者独自の見解であり、所属企業における立場、戦略、意見を代表するものではありません。 個人的に心がけていること 当該文書の作成目的や位置付けを冒頭に記載する
読みやすい文章を書くための技法 - RyoAnna
『坊っちゃん』自筆原稿 読みやすい文章とは、流れるように読める文章だ。難しい言葉はいらない。気のきいた言葉もいらない。文頭から文末まで振り返ることなく読める文章が、最も美しい。 読みやすさの基準は客観的なものだ。読み手には様々な人がいる。老若男女すべての人に対して読みやすい文章を書くのは難しい。ただ、綺麗な文章を書こうとする意識は持ちたい。 文章を書く上で意識すべき技法を紹介する。 常体と敬体 常体とは「だ・である」調の文章であり、敬体とは「です・ます」調の文章を指す。それぞれにメリットとデメリットがある。 常体は、自分の意思を力強く伝える事ができるが、我の強い文章になる。敬体は、優しい印象で共感を得やすいが、まわりくどい文章になる。 常体と敬体を織り交ぜて書く手法もある。まずは自分で試してみて、書きやすい文体を見つければいい。 文章の始まりは短く 最初の一文は短いほうがいい。インパクトが
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
