DocumentationTools - Python Wiki
This page is primarily about tools that help, specifically, in generating documentation for software written in Python, i.e., tools that can use language-specific features to automate at least a part of the code documentation work for you. The last section also lists general documentation tools with no specific support for Python (though some of them are themselves written in Python). Tools that s
テストする -- Style Guide for Online Hypertext
ドキュメントをテストする ある意味でハイパーテキストは書物と同様で、校正が必要です。またある意味でそれはプログラムと同じく、テストをしなければなりません。少なくともドキュメントが対象としている読者グループから何人かを選び、それを読んでもらってフィードバックを受けるようにしましょう。ほかのアイデアとしては： ドキュメントを複数の異なるブラウザで読んでみて、機種依存が無いことを確認する 読者の傾向を観察する。これはサーバーのログファイルを分析することで可能になります。ある部分が読まれていないとすると、読者は間違ったところを探している可能性があります。読者がある一定の道筋を行き来していることが分かるかもしれません。彼らが何を求めているかが推測できれば、リンク周りの手がかりをもっと使いやすく改善できるでしょう。（利用者に関する情報を削除するまでは、ログ情報は秘密扱いにすること）。 読者からの批判や
DMM inside
なぜDMMがweb3に参入したのか。Seamoon Protocolが目指す新たなエンタメ体験の未来とは
技術的な文章を書くための1歩、2歩、3歩 - Qiita
ちょっと書きたくなったので書くんじゃーい！ この文章を読み終わった時、読者がそれなりわかめ品質な文章を出力できるようになり、どこかに寄稿した時に全面リテイクを食らったりしないようになることを目指します。 mhidaka が 0歩目を書いてくれました！ 背景 筆者は普通のエンジニアです。その辺の開発とかしてる会社に勤めています。技術系の原稿も書きます。 原稿書きでご飯食べてるわけではありません(晩ご飯が豪華になることは稀にあります)。 今まで有能なレビューワー(muなんとかさんとか)編集さんとか(某社の安藤さんとか)とかとかに鍛えていただきました。 この場を借りてお礼を述べておきたいと思います。ありがとうございます。 なお、この文章は2013年10月時点での筆者(わかめ)のやり方です。 将来的にはより良いやり方を見つけるでしょうし、これとは全く違う書き方で上手にやっている人もいると思います。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Mocha Documentation — Mocha 0.1.2 documentation