読みやすいREADMEを書く | Yakst

テクノロジーカテゴリーの変更を依頼記事元:

yakst.com

919users がブックマークコメント

コメント

51

記事へのコメント51件

注目コメント
新着コメント

t-wada README、とても大事なのはわかっているが、書く側に回ると意外といろいろ書き漏らしてしまう。これを読んで自分のプロダクトを改善しよう。

2016/06/23 リンク

注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

規約違反を報告

アプリのスクリーンショット

いまの話題をアプリでチェック！

バナー広告なし
ミュート機能あり
ダークモード搭載

アプリをダウンロード

関連記事

{{ total_bookmarks_with_user_postfix }}{{ root_title }}

読みやすいREADMEを書く | Yakst

いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADME... いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの

ブックマークしたユーザー

techtech05212023/09/18
katsukiniwa2023/09/11
syou61622022/01/30
franuk2020/01/15
hitsujibane2019/08/11
drumsco2019/07/12
kita-tuba2019/06/20
shinyapple2019/06/10
northlight2019/02/13
AltT2018/12/19
kma832018/07/04
kazkaz032018/06/23
pc-bohemian2018/04/18
tyabu122018/03/01
e24ns2018/02/18
mieki2562018/01/31
TransRadio2018/01/09
urapico2018/01/06

同じサイトの新着

同じサイトの新着をもっと読む

いま人気の記事

いま人気の記事をもっと読む

いま人気の記事 - テクノロジー

いま人気の記事 - テクノロジーをもっと読む

新着記事 - テクノロジー

新着記事 - テクノロジーをもっと読む

いま人気の記事 - 企業メディア

企業メディアをもっと読む

設定を変更しましたx