ドキュメントに固執せよ - gfnweb
どうして人間集団はこんなにも知見の共有を円滑にできないのか？ 改善にはドキュメントにまつわる各個人の心構え・制度設計・技術的解決の全部が必要だという話をしたい． ここでテーマにしているのは，著名OSSなど世の中にいくらでも知見が転がっている対象ではなく，特に企業内の十数人のチームでクローズドに開発しているなどして集合知に頼れない状況下でのドキュメントについてである． 非常に乱暴な言い方をするなら，「コードとか大部分は誰でも書けるようになるものなんよ，そんなところにマッチョイズムとか感じなくてええねん，我々の知的体力や組織性が真に試されるのはドキュメントちゃうんか」という気持ちです — 画力・博士号・油田 (@bd_gfngfn) June 3, 2022 ドキュメントに書く内容の必須項目或るシステム（ソフトウェアなど）について，そのシステムのことを全く知らない人を想定読者としたドキュメント
テクニカルライティングチーム、開発文書部、DevRelのお仕事 2021年12月版 - Qiita
テクニカルライティングチームの仕事についてまとめる。テクニカルライティングチームを作りたい開発チームを想定し、「テクニカルライティングチーム」の役割を概観する。2021年10月頃更新。 Hint 分かりやすいドキュメント、書けていますか？ Amazon、Google、Facebook、Evernote、GitHub…多数の企業が実践しているマーケティング手法がDevRel（Developer Relations）です。外部の開発者とのつながりを形成し、製品やサービスを知ってもらうこと、さらに彼らの声を聞くことでサービスの改善や機能追加に活かしていく活動になります。 日本でもエバンジェリストやデベロッパーアドボケイトと呼ばれる方が増えており、製品やサービスを紹介しています。DevRel Meetup ではそうしたエバンジェリスト、DevRel活動を行っている方が集まり、知見を共有したり情報交
Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい - Qiita
はじめに エンジニアにとって、仕様書などの技術的な文章を書くこと（テクニカルライティングとも言います）は避けて通れません。ただ20年来多くのエンジニアの方々と同僚として接してきて思うことは、エンジニアの方の中には「文章を書く」ということに苦手意識がある方が一定数いるということです。 でもこの「テクニカルライティング」のスキルは、才能というよりは一種の「技能」だと思うんです。ある一定の原理原則を理解して実践を繰り返すことで、必ず一定レベルで習得できるものだと著者は信じています。 もしこのテクニカルライティングの原理原則をまだ体系的に学習したことがない、または過去学習したが改めて再学習したいという方に、お勧めのコンテンツを見つけたのでご紹介します。 https://developers.google.com/tech-writing Every engineer is also a write
ドキュメント作成時のあるあるアンチパターン20 - Qiita
業務でドキュメントを作成するケースは多々ある 例：仕様書・設計書・提案書・メール・障害票．．． ここでは各ドキュメント共通してありがちなアンチパターンをまとめてみました。 1. 表記がバイト表示・マイクロ秒表示 プログラムが出した数値をありのままに表示するパターン ファイルサイズが100MB, 1GBあろうと、バイト表示にする 桁数が多い数値に、桁区切り（,）を入れない 時間を何でもマイクロ秒・ミリ秒にする（1/100万秒までの精度が必要？体感で分かる？） 桁数が多い＝精度が高い＝良い文書、ではなく、見る人が必要とする精度に切り上げることが重要（売上で１円単位まで出すことが無いのと同様） 悪い例 No ファイル名 ファイルサイズ(byte) 処理時間(秒)
簡単に真似できる文章上達術｜ベイジ社内勉強会資料
2019年3月26日に社内で実施した文章力をアップするための勉強会の資料です。プロのライターのようなハイクオリティな文章ではなく、ビジネスパーソンが仕事をする上で最低限機能する上での「上手な文章」を、とても簡単な3つに絞って話をしています。実際の勉強会ではワークもしてもらいました。皆さんもこれを読んで、実際に手を動かして自分の文章を添削してみてください。
企業名・サービス名など固有名詞の表記【Webの文章101】 知識・ノウハウ ホームページ制作なら神戸のWeb制作会社「株式会社ふわっと」
正しい表記に気を配りましょう Webで書く文章には、公式サイトに掲載する文章やブログに書く文章、TwitterやFacebookページに書く文章、そして個人でやりとりするメールまでさまざまなものがあります。 ビジネスマナーとしてわざわざ取り上げることもないくらい、企業名や担当者の名前は誤字のないように気を配るのはごく当然のことでしょう。 しかし、結構いい加減に書かれていることも多く見かけます。 「Twitterだからいいや。」とか「公式な発言じゃないから...」と思われるかもしれませんが、企業名やサービス名の表記くらいは普段からきちんと表記するように心がけておくことが、いざというときに失敗しないコツだと思います。 よく見かける間違い ロゴの表記と混同してしまっているケースが多いのかもしれませんが、全部小文字で書いているものやロゴの表記のままの文字を記載していることをよく見かけます。例えば.
Webサイトで全角英数字ではなく、半角英数字を採用する理由
Webで文章を掲載する際、英数字は半角表記で統一するのが「常識」です。ですが、なぜ全角英数字はダメで半角英数字に統一するべきなのでしょう。改めて聞かれるとついつい「そういうものだから」と答えてしまいがちではないですか？ また、検索してみても、ちゃんとまとめられた記事がなかなか見つけられません。ということで、全角英数字ではなく、半角英数字を採用する理由をまとめてみました。 ※本記事は技術的な検証が十分に行われておらず、誤った情報である可能性があります。あらかじめご了承ください。 全角英数字は再利用性できません たとえば、電話番号やURLが全角で表記されていると、Office製品やメーラーでリンクとして認識されません。ブラウザのアドレスバーにコピーアンドペーストしても開けず大変不便です。 全角英数字は禁則処理が行われません ブラウザでは英単語が途中で改行されないよう折り返しが行われます（禁則処
思わずクリックしたくなる見出しを作るWebライティング術のヒント
第二回Webライティング研究会 開催レポート |... / 「文才」と「経験則」からの脱出！設計思考で書く ... / ブログを書く時は絶対にこの「たった一つの事」を注...他...全6件
Webデザイナーも知っておくべき？人を動かすコピーライティング術
ライター歴1年の私がWebに掲載する文章を書く時... / 1. 目的は人を動かすこと / 全てのWebサイトには公開する目的があります。そ...他...全21件
日本語を書く | Hal-Cana
最近ちょくちょく同業の方とお会いする機会があり、その度にWEBに関する話をするのですが、その中で度々「はるかなさんのブログは読みやすくて面白い」という評価を頂きます。 9割社交辞令とわかっていても尊敬するWEB屋さんから褒められれば嬉しいもので、調子に乗ってこんな記事も書いてしまうというものです。 つーわけで、僕なりの文章表現について書く。 文章を書く上で必ずしも正しい日本語である必要はないのかもしれない 当然の話ですが、単語には正しい意味があります。 しかし同時に、正しい意味とは関係ない解釈というものも存在します。 仕事として物を書く場合はまた違ってくると思いますが、単に趣味として物を書くのであれば、重要なのは解釈の方だと思っています。 噛み砕いて言えば「（自分が）誤解なく書けているか」ではなく「（相手が）誤解なく読めるかどうか」の方が大事ってことです。 ですので、例えば誤用の方が一般化
[web制作]webコンテンツの可読性を左右しそうな要素を思いつくだけ書き出した
最初に定義をしておくと、可読性とは、素早く読めるか、理解しやすいか、読んでて疲れないかという事です。これらにおいて可能な限り優れたものを作ることが、コンテンツと、それを届けようとする各セクションに関わる人が考えるべきことだという事になります。 可読性とコンテンツ まず、何はなくともコンテンツです。文章が読み易いものであることを可読性が高いという言い方をするのは聞いたことがあるかと思います。そのうち、コンテンツ自体が読み易い内容であるかどうかをリーダビリティー(readability)と言います。 リーダビリティーに関わってくるのは 文章量 図版率 内容 表現、言葉遣い といったものです。コンテンツを作る人は、自分の書いている文章の長さ、文字と図の割合、内容、表現の複雑さ等を届ける相手に適したバランスにしなければいけません。 可読性の低いコンテンツ
![[web制作]webコンテンツの可読性を左右しそうな要素を思いつくだけ書き出した](https://cdn-ak-scissors.b.st-hatena.com/image/square/78812e072c3d7a68d5f12a10df31d88ce5989c9f/height=288;version=1;width=512/http%3A%2F%2Fwebcre8.jp%2Fwordpress%2Fwp-content%2Fuploads%2F2013%2F05%2Fweb-readability-legibility-02-150x150.png)
文章に向いてない構造をいかに文章に向いた構造に直列化するかが大事 - きしだのHatena
Software Design 12月号の特集が「なぜエンジニアは文章が下手なのか？」というタイトルだったので、読んでみたら、ちょっと残念な内容だった。 「それは文章で書くべき情報なのか」という章があって、直列化した論理構造であれば文章には書きやすいけど、分岐やループがあるような構造だと書きにくいということが書いてあった。そこで文章化しにくい構造の例として地図があげてあって、暗にそういう構造は文章化をやめて図であらわせと言っているように読める。 けれども、図に書いたところで、書く側は文章化から逃げれて満足かもしれないけど、それを読み取る側は結局どこかから順番に解釈していく必要がある。図に逃げるのは、読み手に責任を押し付けているだけだと思う。 で、「ですから文章を書く前にまず論理構造を考える必要があります」と続いていて、では考えた論理構造が「文章に向かない論理構造」だったらどうするの？逃げる
YouTubeで他人の動画のタグを確認する方法【2020年版】 – スマトク！
YouTubeで動画を投稿する際に、オプションにて「タグ」を設定することが出来ますよね。 Google的にはこのタグによってトラフィックに重大な影響を与えると公表しているワケではありませんが、有名なYouTuberの方もしっかりと設定しています。 これは「同じタグの関連動画に載りやすい」というのが1つの理由と考えられます。ただし、通常だと他人のチャンネルを見てもタグを確認することが出来ないので、今回お伝えする方法を覚えておきましょう。 PCからタグを確認する方法 ・Google Chromeの拡張機能「Tags for YouTube」を利用する ・アドオンを使いたくない場合は「Ctrl+U」にてタグを直接探す。 スマホからタグを確認する方法 アプリ「Tags for YT」を利用する YouTubeで他人の動画のタグを確認する方法【2020年版】 冒頭でもお伝えした通り、他人のチャンネル
わかりやすい文章の10大原則
この記事では、LINEグループに招待できない・参加できない時の対処法や原因についてお伝えしていきたいと思う。 複数人で連絡を行う際にLINEのグループ機能は非常に役に立つ。学校でも職場でも利用されている事が多く、グループ内通話も出来るので簡単な打ち合わせ程度であれば、LINEでも可能になった。 グループの作り方も非常に簡単。 しかし、なぜか相手に招待が届かない…といったことも度々ある。 では、この招待が届かない時によくある原因について見ていこう。 LINEグループに招待できない時の対処法・原因 基本的に以下の場合は、相手に招待を送っても届かない。 既にLINEを退会している(アカウントを変更している)場合 既に招待を送っている場合 相手にブロックされている場合 もしくは、招待しているけれど参加されない…といった場合は、相手側が参加を拒否している可能性もある。 上記の3点に当てはまらない場合
ちょい長めのコピーを論理的に、わかりやすく書く 構成は「スリーポイント」、表現は「ワンブロック・ワンテーマ」
『MarkeZine』が主催するマーケティング・イベント『MarkeZine Day』『MarkeZine Academy』『MarkeZine プレミアムセミナー』の 最新情報をはじめ、様々なイベント情報をまとめてご紹介します。 MarkeZine Day
iOS11以前のiPhoneで画面を録画する方法や無料アプリはある？ – スマトク！
この記事では、iPhoneの画面を録画する方法についてお伝えしていく。脱獄無しで録画できる方法・録画可能なアプリを中心に触れていこう。 「スクリーンショットだけでは伝わりにくい」,「かと言ってGif形式で編集するのも面倒くさい」。 iPhoneの画面の状況を誰かに伝える上で、このような悩みを抱える方は少なくないハズだ。 言葉や画像を使って説明するよりも、実際に自分が行った行動そのものを動画に保存して説明すれば、非常にスムーズに理解してもらえる。 特にゲームアプリのプレイ動画をSNSやブログなどを通して、誰かに見せたい場合、その録画機能があればかなり楽になる。 現在のiPhone・iPadではそういったアプリに対応しているのか見ていこう。 iPhoneの画面を録画する方法!脱獄無しで使えるアプリはある？ iOSの標準機能で画面の録画を行うことは出来ない。 そのため、録画可能なアプリをリリース
句点の打ち方 基本編 【文章技術：句読点の打ち方】：エディテック：オルタナティブ・ブログ
これまで、以下のエントリー（文章技術：句読点の打ち方）で句読点の打ち方について検討してきましたが、読点（テン）の話ばかりで句点（マル）については説明していませんでした。そこで今回は、句点の打ち方の基本について見ていくことにしましょう。 なお、今回の「基本編」では実用文・ビジネス文書を対象とし、詩や小説などの文芸作品は扱いません。 【文章技術：句読点の打ち方】 ｜ 読点を打つ日 ｜ 読点がいっぱい ｜ 文の意味を変えてしまう読点 ｜ ご存じのとおり、句点とは 文の終わりを示す「。」の記号 のことです。このように「文の最後に打つのがマル」という説明で済めばいいのですが、実際にはあといくつか知っておかなければならないことがあります。以下では、現代的なビジネス文書では「このように書けば問題なし」という句点のルールを示したいと思います。 皆さんの会社でも、独自に「社内文書標準」のようなスタイルガイド
第1回 Webライティング・エディトリアル勉強会 まとめ - WebSig24/7公式ブログ
posted on 2010.05.09 23:40 0 trackbacks みなさんこんにちは、モデレーターの渡邊です。 先日のUst放送で岡本さん、村山さんに頂いた回答ですが、テキストでも頂いておりますのでどうぞご覧下さい。 一部、放送中に割愛した質問回答も入っています。 個人的には「あらかじめ」話をしておくとか、方向性を共通認識としておくとか、線引きをしておくことが大事なのだなと思いました！ 1.原稿にそのものに関して （1-1）なにがよくて何が悪いのか判断の善し悪しがつかない どこに基準を定めたらよいのか （質問） 社内のマーケティング担当者に「文章書いてデザインしてコーディングをしておいて」とか、外部作成のインタビュー記事を「チェックしておいて」などと言われます。書いた文章は赤字にだらけになって直されます。インタビュー記事は文章があまり良くないのはわかるのですが、ライターさんに
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
サービス終了のお知らせ - NAVER まとめ
IDEA * IDEA
