開発のドキュメントをどこに置くか問題 - $shibayu36->blog;

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

blog.shibayu36.org

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

コメント

19

記事へのコメント19件

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

オーナーコメントを固定しています

オーナー shiba_yu36 昨日議論した内容書いた。この辺結構難しい

2014/02/05 リンク

t-wada “基本は実装に一番近いところにコメントとしてドキュメント書くのが良くて、とはいえ導入ないと分からないよなという部分には俯瞰できるように図とか置いておきたい”

2014/02/05 リンク

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

規約違反を報告

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

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

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

アプリをダウンロード

関連記事

{{ total_bookmarks_with_user_postfix }}{{ root_title }}

開発のドキュメントをどこに置くか問題 - $shibayu36->blog;

最近開発用のドキュメントをどこに配置するか悩んでて、いくつか試して見てる。今回言っている開発用の... 最近開発用のドキュメントをどこに配置するか悩んでて、いくつか試して見てる。今回言っている開発用のドキュメントというのは、コードの触り方も含んだサービスの開発に関するもの。例えば開発環境セットアップ方法ページに表示している広告をどのように切り替えたりするか(googleの管理やコードの変更も含めた) サービス内の特定の機能の仕組み内部用HTTP APIドキュメントなどを指している。結構いろいろ考えるところがあるので、思っていることをまとめてみたい。一応先に結論を言っておくと基本は実装に一番近いところにコメントとしてドキュメント書くのが良いと思ういろんなパーツが絡みあうような大きな機能の場合、導入部分だけ別の場所に書く出来るだけrepository内に入れておくと探しやすく、更新しやすいと思うあといろいろ悩んでるので事例あったら教えてください。起きている問題ドキュメントは

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

techtech05212023/11/12
kiichi692512017/05/31
odz2016/06/06
ichi24102016/06/05
e10kg2016/06/04
kirakira11062016/06/04
arebouya2016/06/04
mcddx302016/06/04
masa8aurum2016/06/04
collonbooks2016/06/03
daichann19822016/06/03
inoyawakumara2016/06/02
maangie2016/06/02
dev0000_12016/06/02
houyhnhm2016/06/02
ch12482016/06/02
rockykulkul2016/06/02
manabou2016/06/01

同じサイトの新着

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

いま人気の記事

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

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

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

新着記事 - テクノロジー

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

設定を変更しましたx