スケールする組織を支えるドキュメンテーションの技術を”GitLab Handbook”から学ぶ｜Anno Takahiro
ドキュメント文化は健全な組織のスケールのために必要 組織の中でドキュメント/文章を残し活用していくことはとても重要だ。クオリティの高いドキュメントがあることで、組織に情報が流通し、透明性を確保できるようになる。情報を流通させるためにいちいち口頭の説明がいらないから、メンバーの数が増えた時でもスケールしやすくなる。過去の結論にアクセス可能になるので、議論を積み上げていき、意思決定のクオリティを高めることにもつながる。そもそも何かを読むということは何かを聞いて教わるよりも時間あたりの処理量が多いし、非同期に実施できる。良いドキュメントをアセットとして社内に蓄積していくことはスタートアップのみならず、ありとあらゆる組織が成長していく上でとても重要であると言える。 しかしその一方で、良質なドキュメント文化を徹底できている会社は多くないように見える。例えば、社内のドキュメントを蓄積させていく場所とし
プロダクトに対するなぜをesaで集める - chiastolite’s blog
サービスは運用していくうちに、トレードオフをした結果だったり歴史的経緯だったり外部要因によったりで一見不思議な仕様が生まれたりする。 そういうものを途中から入った人が、頭ごなしに否定するのは幸せとはいえない。 ということでesaに↓みたいなテンプレートを作ってみた。 疑問に思ったことを書いて経緯をしってる人が答えるみたいな運用を期待している。 また回答がない記事を一覧表示できるよう、解答待ちリスト用リストを出すための記事を用意してテンプレートでそこにリンクを張るという工夫をしている。 どの機能/サービス? --- 疑問に思ったこと --- ソースコード --- (場所がわかれば。なおGitHubのリンクを貼るときは y を押してSHA1を指定してもらえると後々ズレが出なくてうれしいです) 理由 --- (可能であればコンフル/Slack/Backlogなどのパーマネントリンクも添えてくださ
技術書を作るための技術スタック | メルカリエンジニアリング
Mercari Advent Calendar 2017の3日目はmhidakaがお送りします。 Advent Calendarで空いてるところに収まったら12月3日は日曜日ということで、エンジニアの趣味的な話です。 筆者は技術的なブログや書籍を書くかたわら、技術書のためのイベントなどを開いてます。 技術を追求すること、プログラミング、まとめることが好きでモバイル分野で継続的に書籍を出版しています。 内容はおおむね同人誌作りへ適用している技術の話です。 書籍の作り方は出版社によっても違いますが、紹介する内容と同様の作り方をしている商業書籍もたくさんあります。 ここでは著者の目線から出版業界のテクノロジーをのぞいてみましょう。 作る楽しみと読者の視点 著者が本を書く動機は人それぞれですが技術を広めたい、たくさん売れたい、自分の知識をまとめたいなど目的を持って書き始めます。 また一方で書籍の目
イベント/2017/08/29/Markdown勉強会/esa Markdownの思想とデザイン - esa-pages.io
Markdown Night 2017 Summer 2017.08.29 esaLLC @ken_c_lo 自己紹介 赤塚妙子 Twitter: @ken_c_lo GitHub: @taea esa LLC デザイナー デザイン・コンセプトメイキング RailsのView部分 / CSS esa.io pplog.net 今日お話したいこと esaを通して、Markdownの良さは何かを探っていきたい esaのコンセプトを通して考える esaの利用実態から考える Markdownのスタイリングの話（おまけ） Excuse 「エンジニア」という用語について ※この発表で出てくる「エンジニア」は自分たちの身近にいるようなWeb系のエンジニア、もしくはそれに親しい文化や習慣を持っている人達のことをやんわりと指してます。 どうして Markdownを使うのか？ えっ、なんでだっけ……？？？ 正
プログラミングスタイルガイドのスタイルガイド - Qiita
本文書は、プログラミング言語向けのスタイルガイドに向けたスタイルガイドである。 本文書へのフィードバックはQiita上のコメントにて受け付ける。 構造 対象を明確にする そのスタイルガイドがどのような状況のどのような対象に向けたスタイルガイドであるか規定すること。 状況や対象は広すぎてはならない。 理由: 対象はスタイルガイド記述者には自明かもしれないが、似て非なる言語に誤用されたり、特定分野のアプリケーション向けスタイルガイドが他分野のアプリケーションを理不尽に拘束したりすることがある。これを防ぐべきである。 良い例: 「本文書はRuby on Railsアプリケーション向けのスタイルガイドである」 「本スタイルガイドはX社におけるRubyプロジェクトに適用すべきスタイルを規定する」 悪い例: (何も書かない) 「本文書はX社におけるすべての開発に適用される ... 述語メソッドや述語関
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
