読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
Welcome to our community!
Welcome to our community!¶ Write the Docs is a global community of people who care about documentation. We consider everyone who cares about communication, documentation, and their users to be a member of our community. This can be programmers, tech writers, developer advocates, customer support, marketers, and anyone else who wants people to have great experiences with software.
Introducing docs.microsoft.com
This post was written by Jeff Sandquist, General Manager in the Cloud + Enterprise Division. Today we're announcing the preview release of our new documentation service /, showcasing content supporting our Enterprise Mobility products. Why docs.microsoft.com? In short, content matters. We interviewed and surveyed hundreds of developers and IT Pros and sifted through your website feedback over the
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Video Archive
CI/CD For Documentation -- Meetup Reboot, Fri, Dec 2, 2016, 6:30 PM | Meetup
Transforming your Documentation Process
Eventbrite
