ドキュメント文化を支える不文律 - ROUTE06 Tech Blog
ROUTE06では、GitLab Handbook*1を参考に、全社に関係する情報をハンドブックとして社内に公開しています。ハンドブックは2023年8月時点で383ページ*2あり、50人前後の組織規模の会社としては文章化に積極的なことが現れている数字だと思っています。 また、ハンドブックとは別に、プロジェクトごとのレポジトリでは技術選定や設計方針をADR*3で残していたり、参加したセミナーのレポートをGitHub Discussionsに書いていることからも、ROUTE06で働く人は文章を書くことが習慣になっていると感じます。 そんな中、ある日社内のSlackに一つの問いが投げかけられました。 ドキュメント文化というのは、たとえばマニュアルに書いてないから分からなかった・故になんらかの失敗が発生した場合、マニュアルに書いていなかったことが悪いみたいな考え方になるのでしょうか 社内のSlac
スケールする組織を支えるドキュメンテーションの技術を”GitLab Handbook”から学ぶ｜Anno Takahiro
ドキュメント文化は健全な組織のスケールのために必要 組織の中でドキュメント/文章を残し活用していくことはとても重要だ。クオリティの高いドキュメントがあることで、組織に情報が流通し、透明性を確保できるようになる。情報を流通させるためにいちいち口頭の説明がいらないから、メンバーの数が増えた時でもスケールしやすくなる。過去の結論にアクセス可能になるので、議論を積み上げていき、意思決定のクオリティを高めることにもつながる。そもそも何かを読むということは何かを聞いて教わるよりも時間あたりの処理量が多いし、非同期に実施できる。良いドキュメントをアセットとして社内に蓄積していくことはスタートアップのみならず、ありとあらゆる組織が成長していく上でとても重要であると言える。 しかしその一方で、良質なドキュメント文化を徹底できている会社は多くないように見える。例えば、社内のドキュメントを蓄積させていく場所とし
21世紀の文字起こし - the code to rock
気づき そもそも文字起こしとは そもそも文字起こしとは（2） 音声入力による文字起こしの実践法（Mac） 1. 素材音声の再録音 2. Soundflowerの準備 3. Mac内部で再生＋聞き取り 4. 音声ファイルが終わるまで再読み込みなどのケア まとめ 〜そしてtextlint編へ〜 続編 気づき 少し前にこのようなことに気がついた。 ひえーすごい発見をした。音声入力で文字起こし作業をナシにできないかなあ、と思って対談の音声データをiPhoneのそばで大音量で再生したけど全然認識せず。ですよねー、と一旦諦めた後にふとイヤホンで聴きながらシャドウイング的に自分で喋ったらだいぶテキスト化された（笑）これはいいのでは— Hiroaki Kadomatsu (@note103) 2016年7月6日 「いずれそうなるだろう」とは思っていたが「まだしばらく先のことだろう」とも思っていた現実が、想
読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
esa.io - Expertise Sharing Archives for motivated teams.
Nothing is perfect from the beginning. We want to support the growth of documents from hatching to completion. 最初から完璧なものなんてない。 esaは情報の一生を見守りたい。
個人的な良い記事のガイドライン = 2ヶ月前の自分が泣いて喜ぶような記事を書く - Qiita
はじめに 昨日、こちらの記事を拝見しました。 良い記事を書くためのガイドライン - Qiita:Support 上の記事は「あなたの知識が他の誰かの役に立つようにするため」のQiita公式のガイドラインです。 これを読んでると「うんうん、なるほど。そうだよねー」と思うところばかりでした。 それにかこつけて、僕もどういうことを考えながらブログやQiita記事を書いているのかを紹介してみようと思います。 何を考えながら書いているのかというと、この記事のタイトルにある通りです。 まあ「2ヶ月前」っていうのは適当で、「昨日」でもいいし、「2年前」でもかまいません。 要するに「2ヶ月前の自分」＝「その知識を知らなかった頃の自分」ということです。 技術記事を書くときは、自分の書いた記事を過去の自分に見せたときに、 「あー、なるほど！最初っからそう説明してくれたらすぐわかったのに！！」 と大喜びしそうな
自由であるためにドキュメントを作る - 設計者の発言
前回記事で、ドキュメンテーションを重要視しない開発業者を避けるべきだと指摘した。同様の問題は、業務システムを内製した場合にも生じている。むしろ、ドキュメントレスな困ったシステムは、内製で生み出されているケースのほうが多いような印象が私にはある。 ドキュメントレスなシステムが重大なリスクを抱えていることを、ほとんどの経営者は認識していない。なぜなら、ドキュメントレスであってもシステムのあり方は内製担当者の「頭の中」に入っているので、彼に頼めば必要な改修はやってもらえるからだ。結果的に業務システムが、担当者のエンプロイアビリティ（雇用意義）を強化するための政治的ユーティリティと化すことを許してしまう。その歪みは、担当者がいなくなったときに一挙に顕在化する。いなくなった当人としては「後は野となれ山となれ」である。 業務システムがドキュメントレスになりがちな根本的な理由は、まさにここらへんにある。
overlasting.net
overlasting.net 2020 Copyright. All Rights Reserved. The Sponsored Listings displayed above are served automatically by a third party. Neither the service provider nor the domain owner maintain any relationship with the advertisers. In case of trademark issues please contact the domain owner directly (contact information can be found in whois). Privacy Policy
2010-03-20
なんでもかんでも、お疲れ様。メールの挨拶も、「お疲れさまです。hyoshiokです」朝でも昼でも夜でも「お疲れ様です。hyoshiokです」。飲み会で乾杯するときも「お疲れ様で〜す」、ジョッキをがちゃーん。会社でプレゼンする時も「お疲れさまです。開発部のhyoshiokです」。そして退社するときも「お疲れさまです〜〜」。飲み会での最後の挨拶も「お疲れ様でした〜」 みんな、お疲れなんだなあ。大変なんだなあ。そんなにお疲れしないように、肩のチカラ抜きましょう。もみもみ。凝ってますね〜皆様。 コードはHOW、テストはWHAT、ドキュメントはWHY。 先日のソースコードリーディングワークショップ2010でそんなようなことをお話した。 これは文字通りの意味だ。コードは実装の詳細HOWを表現している。どのように問題を解いたか。プログラマの数だけ表現がある。一方テストはWHATだ。何を実現するかを表して
SpiderMonkey: The Mozilla JavaScript runtime - Mozilla | MDN
SpiderMonkey is Mozilla's JavaScript engine written in C and C++. It is used in various Mozilla products, including Firefox, and is available under the MPL2. Guides Building SpiderMonkey Build Documentation How to get SpiderMonkey source code, build it, and run the test suite. Using SpiderMonkey Introduction to the JavaScript shell Documentation of the command-line JavaScript shell, js. JSAPI User
Linux Kernel Documentation
Documentation extracted from the Linux kernel and mirrored on the web where Google can find it: html/latest - Kernel Documentation (mainline) html/next - Kernel Documentation (linux-next) README various README files scattered around Linux kernel source Output of kernel's "make help". Standards documents applicable to the Linux kernel Single Unix Specification v4 (Also known as Open Group Base Spec
mixi Engineers’ Blog » manを書こう
チャリンコ通勤もそろそろ寒くなってきたと感じる今日この頃のmikioです。今回は、manの書き方について述べてみます。 manとは UNIX系のフリーソフトウェア/オープンソースソフトウェアを世に出す場合、その使い方を示した「man」形式のマニュアルを付属させるのが一般的です。端末上で「man hoge」とやると「hoge」のマニュアルを見ることができるので大変便利で、UNIXを使っている方は日々お世話になっている機構だと思います。ちなみに「man -t hoge」とやるとPostScript形式のデータが出力されるので印刷して見ることもできるんです。 そういうわけでUNIXのソフトウェアはmanをつけて配布するのがあたりまえ的になっていて、つけてないと「なんでやねん」とお叱りをうけることもあります。Debian/GNU Linuxでは、パッケージに含まれる全てのコマンドには各々に対応する
Vim documentation: help
main help file *help.txt* For Vim バージョン 7.1. Last change: 2006 Nov 07 VIM - メインヘルプファイル k 移動: カーソルを使用するか、"h" で左、"j" で下、 h l "k" で上、"l" で右に移動できます。 j ヘルプの終了: ":q<Enter>" とタイプします。 Vimの終了: ":qa!<Enter>" とします(注意! 変更はすべて破棄される)。 項目へジャンプ: タグ (例:|bars|) にカーソルを合わせ、CTRL-] を押します。 マウスでジャンプ: ":set mouse=a"と入力してマウスを有効にしてください(xterm もしくはGUIでのみ可)。タグ (例:|bars|) をマ
DocBook.org
Hello and welcome!This is the official home page for DocBook 5: The Definitive Guide. The definitive guide is the official documentation for DocBook. The latest edition covers DocBook V5.0. It was published by O'Reilly Media and XML Press. In support of DocBook users everywhere, this book and its source XML are available online. Of course, you're always free to buy a copy, too, if you'd like :-).
Nettica VPN Service » Make Your Own Cloud
Welcome to Nettica!Join the Cloud! We are a cloud-based VPN service built on WireGuard™ technology, providing fast, secure connections to local and cloud resources. Create your own cloud! Seamlessly switch between local and multi-cloud environments managed with the Nettica Agent. Take command of your network from anywhere! Our OAuth2 and role-based access control features ensure a secure environme
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Google Code
Google Code Archive - Long-term storage for Google Code Project Hosting.
Apple Developer Documentation
SLOT DEMO PRAGMATIC : Situs Duta168 Menyediakan Game Gratis Terlengkap
Linux JF (Japanese FAQ) Project.