Welcome - Microsoft Writing Style Guide
Make every word matter Welcome to the Microsoft Writing Style Guide, your guide to writing style and terminology for all communication—whether an app, a website, or a white paper. If you write about computer technology, this guide is for you. Today, lots of people are called upon to write about technology. We need a simple, straightforward style guide that everyone can use, regardless of their rol
About this guide | Google developer documentation style guide | Google for Developers
Send feedback About this guide Stay organized with collections Save and categorize content based on your preferences. This style guide provides editorial guidelines for writing clear and consistent Google-related developer documentation. If you're new to the guide and looking for introductory topics about our style, then start with Highlights, Voice and tone, and Text-formatting summary. Otherwise
これだけ気を付けて書いてもらえるとみんな幸せになるポイント2つだけ / Two things to keep in mind about writing to make everyone happy
文章を書く技法的なものは多くあり、そういったものすべてに対応しなくても「わかりやすい文章だ！」と言っていいはずです。今回は、私が特に重要だと考えている「名前を大事にしてほしい話」と「あらかじめ読者との距離を近づけて欲しい話」の2つのポイントに絞って、文章を書くときのポイントをお伝えします。技術者の業務の一環として文章を書いている方、自分が書いている文章を改善したいけど、どこから手を付けると効率がいいか迷っている方に、きっかけを伝えるためのセッションです。 ■ 発表者 矢崎 誠 / LINE株式会社 テクニカルライター https://twitter.com/yazakimakoto ■ セッション動画 https://youtu.be/nmFVXJGiCxM?t=1017 ※こちらは以下イベント内で発表した内容です https://line.connpass.com/event/20565
質の高い技術文書を書く方法 - As a Futurist...
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた
LINE株式会社は、2023年10月1日にLINEヤフー株式会社になりました。LINEヤフー株式会社の新しいブログはこちらです。 LINEヤフー Tech Blog こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。今日は、私が1文を書くときに気をつけていることや手法についてお話しします。 そして、この書き出しは、6月にmochikoさんが書いた「LINEの社内には「テクニカルライティング」の専門チームがあります」という記事のオマージュになっています。mochikoさんが書いた記事ですごいpvをたたき出したそうなので、人のふんどしで相撲を取ってみようという作戦で始めてみました。 この記事ではLINE社内で私が講師を務めた「LINE社内で大評判のテクニカルライティング講座」に沿って、わかりやすい1文を書くコツを紹介していま
ドキュメントの構造化による、良いドキュメントの作成方法 | gihyo.jp
あけましておめでとうございます。 ソフトウェアを開発し公開する場合、ドキュメント（マニュアル）を作成することが求められます。しかし、良いドキュメントを作成する方法というのはあまり知られていません。どのようにすれば良いドキュメントを作成できるのでしょうか？ 本稿では、ソフトウェアと同じくドキュメントを要素と性質に構造化することで、良いドキュメントを作成する方法を紹介します。そして、その要素と性質に対してアプローチを行っているESDocというJavaScript（ECMAScript2015）向けのドキュメンテーションツールについても簡単に紹介します。 対象とするドキュメント ドキュメントと一口にいっても仕様書、設計書、マニュアルなど様々な種類が存在します。そこで、本稿が対象とするドキュメントを「ライブラリやフレームワークなどを開発するソフトウェア開発者自身が、そのソフトウェアの使い方をエンド
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
説明文書/スタイル ガイド - MediaWiki