【汎用ソフトスキル】ドキュメンテーションの続け方

2022/03/29 227 users 続け方

この記事の目的 最近「良いドキュメントが作れているな」と思う機会が増えてきたので、その知見をアウトプットしたくなった。 想定読者 今所属してる組織(会社/プロジェクトなど)のドキュメントがイマイチで悩んでいる人 そもそもドキュメントが無い組織に所属していてつらい思いをしている人 「ドキュメントを作れ」と... 続きを読む

継続的ドキュメンテーション: Github DiscussionsとADRのすすめ - LIFULL Creators Blog

2021/09/11 137 users ADR GitHub Discussions

こんにちは。テクノロジー本部のyoshikawaです。好きなW3C Recommendation は RDF 1.1 Concepts and Abstract Syntax です。 会議やチャットでのやり取りの決定事項・議事録、アプリケーションや機能の設計書・仕様書、READMEなどなど... LIFULLの開発現場においては、ソースコード以外にもこのように様々な文書の管理・... 続きを読む

プログラマーがドキュメントを書かない理由 - ITnews

2021/06/03 495 users ITnews medium トキ プログラマー ドキュメント

この記事は、著者の許可を得て配信しています。 Why programmers don’t write documentation 最近ではずっとコードのドキュメンテーションに関連した記事を書いていたので、当然、私のMediumのおすすめ記事には「開発者がドキュメントを書かない本当の理由」という記事が表示されるようになりました。この記事では、ドキ... 続きを読む

リモートワークのいま学びたい、GitLab Handbookと徹底した文書化への狂気 - Qiita

2021/03/01 259 users Qiita Problem リモートワーク GitLab 狂気

Help us understand the problem. What is going on with this article? 1200人以上の全社員がリモートワーク。GitLabが公開する「リモートワークマニフェスト」は何を教えているか？ スケールする組織を支えるドキュメンテーションの技術を”GitLab Handbook”から学ぶ その コメント GitLab Handbookで面白かったもの@コ... 続きを読む

Oh Shit, Git!?!

2020/11/12 425 users Git ニワトリ oh shit 事柄 ハマリ

Gitって難しい。簡単にぐちゃぐちゃの状態になっちゃうし、失敗を直す方法を知ろうとしたところでまじくそ不可能。Gitのドキュメンテーションって卵とニワトリの問題みたいなところがあって、ハマりから抜け出すために知ってないといけない事柄の名前をあらかじめ知っていないと、どうやって問題を解決したらいいのか検... 続きを読む

スケールする組織を支えるドキュメンテーションの技術を”GitLab Handbook”から学ぶ｜Anno Takahiro｜note

2020/02/14 265 users スゲー GitLab Handbook 口頭 スケール 組織

ドキュメント文化は健全な組織のスケールのために必要　組織の中でドキュメント/文章を残し活用していくことはとても重要だ。クオリティの高いドキュメントがあることで、組織に情報が流通し、透明性を確保できるようになる。情報を流通させるためにいちいち口頭の説明がいらないから、メンバーの数が増えた時でもスケー... 続きを読む

Googleが社内のドキュメンテーションスタイルガイドを公開 | TechCrunch Japan

2017/09/08 636 users TechCrunch JAPAN Google 社内 公開

ドキュメンテーションは往々にして、後（あと）からの付け足しだ。オープンソースのプロジェクトではとくにそれが多い。そのため新しい人が後日そのプロジェクト参加しづらくなったり、ときにはヘタなドキュメンテーションのせいでコードがかえってわかりづらくなることもある。そこでGoogleは、デベロッパーがもっと良いドキュメンテーションを書けるために、同社の developer-documentation st... 続きを読む

2016/09/15 141 users angular バグ修正 正式リリース後 解説 予定

どうも、らこです。 ついに Angular 2.0.0が正式リリースされました ！めでたい！！ 今回はRC.7も含めた変更点の解説に加えて、正式リリース後のAngularの予定についても紹介します。 RC.6からの変更点 RC.7、2.0.0ともに、ほとんどがバグ修正とドキュメンテーションの追加で、破壊的な変更はRC.7にひとつあるだけです。 2.0.0-RC.7 2.0.0 破壊的変更 ...M... 続きを読む

Elixirだ 第6回

2015/07/02 80 users Phoenix mix タスク Inc Elixir勉強会

Transcript 1. 第6回 - Phoenixだ - GMO Pepabo, Inc. Joe Honzawa 2015/6/25 Elixir勉強会 Elixirだ 2. 前回やったこと > Mix > ドキュメンテーション > タスクを作ろう > Dialyzerで型チェック 3. 今回の内容 > Phoenixをちょっと飛ばす > インストールとプロジェクト作成 > ファイルを眺める... 続きを読む

良質なAPIドキュメンテーションと共にAPI利用者のためのデベロッパハブも提供するReadMe - TechCrunch

2015/03/14 94 users README TechCrunch デベロッパ API 企業

Y Combinatorで孵化したReadMeは、デベロッパ向けにAPIを提供している企業が、APIの良質なドキュメンテーションを容易に作れるようにしてくれる。 今はほとんどのサービスがAPIを公開しているから、それらを利用すれば自分が作るアプリケーションやサービスに高度な機能を簡単に実装できる。でも、APIをデベロッパにぜひ使っていただきたい、と願っている企業から見ると、そこにはデベロッパたちの... 続きを読む

ドキュメント用IPアドレスとドメイン | ツチノコブログ

2014/08/05 52 users ツチノコブログ ドメイン example.com ドメイン名

こんにちは 焼き直し的なネタですが、お恥ずかしながら私は知らなかったので共有します。 ドキュメント用にIPアドレスとドメインが予約されているって話です。 RFC2606：ドメインについて ドキュメント用に予約されているドメインは example.com example.net example.org ※これらのドメイン名はドキュメンテーションにおける例を提示するために利用する。このドメインは予約さ... 続きを読む

Infrastructure as Codeと 組織のドキュメンテーション ＋ Immutable Infrastructure事例

2014/03/15 71 users Immutable Infrast JAWS DAYS

Infrastructure as Codeと 組織のドキュメンテーション ＋ Immutable Infrastructure事例 Presentation Transcript Infrastructure as Codeと 組織のドキュメンテーション ＋ Immutable Infrastructure事例 2014/3/15 JAWS DAYS 2014 Immutable Infrast... 続きを読む

アジャイル開発におけるドキュメンテーションの実際(1) ―― 本当に必要ですか？ そのドキュメント｜Tech Village （テックビレッジ）　／　CQ出版株式会社

2012/04/06 73 users テックビレッジ ドキュメント Tech Village 細谷

アジャイル開発におけるドキュメンテーションの実際(1) ―― 本当に必要ですか？ そのドキュメント 細谷 泰夫 「アジャイル開発注1ではドキュメント（文書）は作らない」と思っておられる方も多いのではないでしょうか．「ドキュメントを作らないアジャイル開発は適用できない」というような意見を聞くこともあります（最近はあまり聞かなくなったが）．確かに，2001年2月にKent Beck氏らによって宣言され... 続きを読む

Twitter謹製のCSSフレームワーク『Bootstrap』が大幅バージョンアップ中！ | IDEA*IDEA

2011/09/18 463 users Bootstrap IDEA CSSフレームワーク 本日

以前ご紹介したBootstrapですが、良い感じにマイナーバージョンアップを繰り返しているようです。地味にウォッチしていたのですが、本日、v1.3.0になってかなり使いやすくなったので再度ご紹介。 ■ JavaScriptライブラリも出来た！ これが一番うれしいぞ！ 以前はドキュメンテーションがいまいちで、完全に動作させるにはデモページのJavaScriptを解析して・・・なんてことが必要だったの... 続きを読む

ドキュメンテーションを加速するストレスフリーの作図ツール『Blockdiag』 jus2011年6月勉強会

2011/06/19 459 users blockdiag 作図ツール or above

ドキュメンテーションを加速するストレスフリーの作図ツール『Blockdiag』 jus2011年6月勉強会 2 hours ago Loading… Flash Player 9 (or above) is needed to view presentations. We have detected that you do not have it on your computer. To inst... 続きを読む

Geekなぺーじ：プログラマではない人によるドキュメント(ヘルプ)の使い方

2006/12/12 93 users Geek ページ ユーザフレンドリー プログラマ intern

「How non-programmers use documentation」という記事がありました。 面白かったので一部を訳してみました。 間違いなどがある可能性があるので、詳細は原文をご参照下さい。 この記事は、プログラマではない人がどのようにドキュメントを参照するかをまとめています。 これを参考にして、ユーザフレンドリーなドキュメンテーションを作ってくださいと書いてありました。 Intern... 続きを読む