読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
Makefileを自己文書化する | POSTD
私たちのプロジェクトではいつも、非常に長い Makefile を使用して、インストールやビルド、テスト、デプロイメントの処理を自動化しています。ターゲット名はほとんど標準化されていますが（ make install 、 make deploy ）、中には説明が必要なものもあります（ make run-dev 、 make restart-api ）。そして、詳細なmakeターゲットを追加するほど、それらの処理内容をテキスト形式で大量に記載しなければなりません。私たちのプロジェクトでは通常、このような文書を README ファイルに書いています。 しかしCLI（コマンドラインインタフェース）を用いる場合は、主に自己文書化ツールを使っています。 make と打つだけで、利用可能なコマンドとその説明が一覧表示されたら便利だと思いませんか？ それを実現するのは、実はとても簡単です。まずは各ターゲッ
Writing a Friendly README
A README is one of the first things people see when they find your open source project. It should be helpful, welcoming, and friendly. Posted on 14 March 2016 by Rowan Manning. Tagged with Open-Source, Writing, Documentation 87 responsesSyndicated to Twitter Your project’s README is pretty important; it’s often the first thing that a person new to your project will see, and is frequently the only
LovelyDocs. An awesome dev documentation browser.
LovelyDocs. An awesome dev documentation browser.Download now See the gallery Instant offline access to 150+ API documentation sets on the move. In collaboration with Dash for OS X. LovelyDocs is the 1st full-featured, beautiful mobile app for over 150 API documentation sets that helps you solve all your programming dilemma's. Wherever you go, LovelyDocs goes with you. Gorgeous design. With carefu
Velocity - The Documentation and Docset Viewer for Windows
Velocity gives your Windows desktop offline access to over 150 API documentation sets (provided by Dash for OS X) Download Buy Now A Huge Documentation Library Over 150+ API documentation sets are available in Velocity covering some of the most popular languages and API frameworks that you use for everyday development. If you've every seen or used Dash on the Mac then you have a good idea of what
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - killercup/trpl-ebook: UNMAINTAINED