ノンプロ研技術ライティング講座【第1期】第5回

コミュニティ「ノンプログラマーのためのスキルアップ研究会」の技術ライティング講座 第5回のツイートまとめです。 第5回のテーマは「文章を書く技術1」です!
2
前へ 1 ・・ 3 4 次へ
🍊 @ponponmikankan

もちろん見た目がどうやさしくなるか、についても説明されていました。 #ノンプロ研

2021-02-15 21:07:14
@shotarosawada

Web記事の場合はとくに、書かれたものの見た目をとっつきやすくする。 つまり、空間(余白)をうまく使う。具体的には ・空白や空行をを適宜入れる ・漢字→かなに開く ・句読点を適宜入れる など。#ノンプロ研

2021-02-15 21:09:19
@shotarosawada

固有名詞の表記揺れに注意。JavaScriptとGitHubはすごく揺れるなぁ‥ #ノンプロ研

2021-02-15 21:11:02
saitoosamu @saitoosamu

一貫性を持たせる。 パターンを決めて書く。 ある意味マシンのように書くと言う事かも知れない。 #ノンプロ研

2021-02-15 21:11:17
etau @etau0422

固有名詞の表記の揺れもきになるよねー。あと、文章上の表記とロゴとの差で、頭グチャってしちゃう。 #ノンプロ研 #技術ライティング講座

2021-02-15 21:11:25
🍊 @ponponmikankan

さっき沢さんが「文字ぎっちぎちにつまった怨念が感じられる文章が好き」って言ってて人によるなあ、と思った。そして思惑とか気持ちとか考えじゃなく怨念て。 #ノンプロ研

2021-02-15 21:11:43
🍊 @ponponmikankan

【質問】表現の揺らぎチェックってある? ⇒固有名詞の正しいチェックは難しいが揺らぎがあるかどうかのチェックは来週、VSCodeのところで紹介予定。Googleドキュメントにもそのような機能がある。 #ノンプロ研

2021-02-15 21:12:57
@shotarosawada

表記揺れって、専門的な内容であればあるほど信用を失っちゃいますよね。ですから、技術ライティングとしては絶対に押さえておきたい内容だと思います #ノンプロ研

2021-02-15 21:12:59
saitoosamu @saitoosamu

ゆらぎチェッカーがあるらしい #ノンプロ研

2021-02-15 21:12:59
もり@テックライター📙 @moripro3

【リーダブルに書くための作法⑤】 5.一貫性をもたせる 【用語や表記を統一する】 ・大文字小文字の統一 ・記号数字の統一(1年、1年、一年) ・語尾の統一(だ・である/です・ます) ・長音の統一(サーバー/サーバ) #ノンプロ研

2021-02-15 21:13:34
etau @etau0422

長音は er の場合につけるんだっけ、例外もあったような。 #ノンプロ研 #技術ライティング講座

2021-02-15 21:14:05
etau @etau0422

へーしゃのライティングガイドでは、半角と全角の間に、半角のスペース入るね。 #ノンプロ研 #技術ライティング講座

2021-02-15 21:14:33
もり@テックライター📙 @moripro3

固有名詞の表記揺れにも注意しましょう ○Excel ×EXCEL, excel ○Python ×python ○WordPress ×Wordpress 表記揺れがあると、「この記事テキトーだな」という印象をもたれてしまいます #ノンプロ研

2021-02-15 21:16:19
etau @etau0422

こんなのあるよ。 #ノンプロ研 #技術ライティング講座 /[各言語版スタイル ガイドのダウンロード - Microsoft | ランゲージ ポータル] microsoft.com/ja-jp/language…

2021-02-15 21:16:31
etau @etau0422

ちなみに、Google さんの Twitter は、このライティングガイドにめっちゃそってた気がする。 #ノンプロ研 #技術ライティング講座

2021-02-15 21:18:46
🍊 @ponponmikankan

情報密度 ⇒文字数当たりの情報量のこと。 ameblo.jp/writer-yama/en… #ノンプロ研

2021-02-15 21:20:24
@shotarosawada

どこまで説明するか問題。一度きちんと(メタ情報つきで)説明したとみなした内容に関しては、あえてもう説明しないという態度をとるのも大切。そうしないと、毎行コメントを書いたコードのように冗長になってしまう。#ノンプロ研

2021-02-15 21:21:18
saitoosamu @saitoosamu

情報密度の高い言葉を使いこなせるようになりましょう。 #ノンプロ研

2021-02-15 21:24:30
もり@テックライター📙 @moripro3

【リーダブルに書くための作法⑥】 6.適切な密度で 「密度」とは「文字数あたりの情報量」のことです ・新出単語を定義する ・既知の情報は何度も書かない ひとつの文章に情報をギュウギュウに詰め込まないようにしましょう #ノンプロ研

2021-02-15 21:24:49
🍊 @ponponmikankan

コメントばっかりだとコメントのほうに目が行ってしまう可能性がある。やさしすぎるのもよくない。 #ノンプロ研

2021-02-15 21:26:07
🍊 @ponponmikankan

【質問】専門用語が突然出てきたときにブログで気を付けることは ⇒ブログはシリーズ化しているので記事の中で説明するようにしている。途中から見た読者にはバックナンバーを読むように誘導する。 #ノンプロ研

2021-02-15 21:28:33
前へ 1 ・・ 3 4 次へ