2016-06-30 「正しい」運用ドキュメントの書き方¶ 2016年6月30日開催のssmjpでの発表資料です。
2016-06-30 「正しい」運用ドキュメントの書き方 — OpsLab
2016-06-30 「正しい」運用ドキュメントの書き方¶ 2016年6月30日開催のssmjpでの発表資料です。
わかりやすいドキュメントを書くには 〜 全体像を把握できることが重要 - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? はじめに エンジニアなら誰でもたくさんのドキュメントを読むことになります。 その中にはわかりにくいドキュメントも少なからずあると思います。 自分はわかりにくいドキュメントは「全体像が掴みにくい」ことが多いと感じています。 そこで、ここではわかりやすいドキュメントを書くための方法を「全体像を把握できるようにする」という視点でまとめてみました。 また、最後に具体例としてQiita APIドキュメントでわかりにくい点の指摘と改善をしてみました。 ここで扱うドキュメントの種類 ここでは仕様書やリファレンスマニュアルといった類のドキュメントを想定
読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
Welcome to Read the Docs — phalcon-docs-ja latest ドキュメント
Welcome to Read the Docs¶ This is an autogenerated index file. Please create a /home/docs/checkouts/readthedocs.org/user_builds/phalcon-docs-ja/checkouts/latest/docs/index.rst or /home/docs/checkouts/readthedocs.org/user_builds/phalcon-docs-ja/checkouts/latest/docs/README.rst file with your own content. If you want to use another markup, choose a different builder in your settings.
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
