basyura's blog

あしたになったらほんきだす。

GitLabに学ぶ パフォーマンスを最大化させるドキュメンテーション技術

目次

  • 序章 ドキュメントについて知る
  • 第一章 世界最先端のリモート組織を支えるドキュメント
  • 第二章 ドキュメントを組織に導入する必要性
  • 第三章 GitLab のドキュメント・テキスト活用に関する思想とルール
  • 第四章 ドキュメントの影響範囲と品質
  • 第五章 GitLab のテクニカルライティングトレーニング
  • 第六章 Value を活用してライティングスキルを向上させる
  • 第七章 メッセージの組み立て方
  • 第八章 メッセージの表現方法

位置: 102

なぜドキュメントに価値があり、どうすればドキュメントを作れるようになるのか

位置: 125

ドキュメンテーションやコミュニケーションにおける共通ルールを作り、なるべく多くのメンバーが「同じ働き方」を理解し実践できるようにする

位置: 306

アメリカの成人の50%は8th-grade(日本の中学2年生レベル)の読解力である

位置: 357

言語化が苦手な人を仕事ができない人であると切り捨ててしまうと、ビジュアル・シンカーが秘めている可能性をつぶしてしまう

位置: 519

GitLabには「 すべては下書きである」という行動原則があり

位置: 537

GitLabではすべての会議にアジェンダとミーティングノートを用意しています。

位置: 605

あらゆる人たちと協力して物事を進めていくためには、 ドキュメントという客観的な場でお互いの情報をアウトプットして、確認し合うこと が効果的なのです。

位置: 803

日本人はセロトニントランスポーター遺伝子が短いタイプ(SS型)が多く、不安を感じやすい人種であると考えられています

位置: 854

他人に対して物事を説明するときに「十分なコンテクストを提供しなさい」とGitLabがいっているのも、 あなたが持っている感覚や感情も含めてドキュメントにアウトプットすることで、認識の違いを乗り越えるヒントになるからなのです。

位置: 1,016

「謝ることができる人が強い人である」という言葉をGitLab Valuesの行動指針として宣言し、評価やフィードバックにも活用するようにしています。

位置: 1,449

GitLabではまずは人の目に触れる状態にして、可能な限り早くフィードバックが得られるようにすることを重要視しているのです。

位置: 1,499

社内のあらゆる人がハンドブックにアクセスでき、基本的に情報がすべて公開されている状況を作ること

位置: 1,689

1つの文は1つの論点に絞ること

位置: 1,699

視認性を高めるためには、 適切なビジュアルと構造化 を活用していきます。

位置: 1,811

GitLabのドキュメント作成トレーニングでは、このうち最も基礎的な「テクニカルライティング1」を受講するように推奨されています。

位置: 1,830

GitLabが提供しているテクニカルライティングコース

位置: 1,860

パラレル構造とは、複数の要素が並ぶときに文法をそろえる書き方

位置: 1,866

各項目のトピックの種類を限定すること

位置: 1,974

どれだけ頑張ったかではなく、どれだけ影響を与えられたかをドキュメントに記載する

位置: 2,393

難しいから課題を整理して乗り越えよう」

位置: 2,448

順序に関係のないものに対して番号付きリストを用いない

位置: 2,491

本多勝一氏の『〈新版〉日本語の作文技術』(朝日新聞出版)

位置: 2,753

すべての会議にはアジェンダを付けるべき

位置: 2,857

パラグラフライティングとは、1つの話題に対して1つの「パラグラフ(文章のまとまり)」を作り、先頭の一文に最も重要な文章を置く書き方です。

位置: 2,943

温かみのある感情を込める