タグ

documentationとtipsに関するdrumscoのブックマーク (6)

  • 文章を書く心がけ

    目次 はじめに 読者に対する心がけ 誰がその文章を読むのかを考えよう 読者は何を知っているかを考えよう 読者がどんな感じを受けるかを考えよう 読者と対話する気持ちになろう 自分に対する心がけ 書こうとせず、読もうとしよう 読もうとせず、読みはじめようとしよう 何でも書いていいんだよ 惜しげなく人に与えよう 人からのものには敬意を払おう 魔法の呪文は毎回発見しよう まず自分がよく理解しよう 知識を誇るために書くのをやめよう その他の心がけ 言葉についての心がけ 長い文は注意して使おう 書いたものは必ず読み直そう 適切な例を示そう 言い換えの練習をしよう 8割でよしとしよう すべてを動員しよう その他の心がけ 環境についての心がけ 人の「気」を意識しよう 頑丈で軽い文章作成のツールを使おう その他の心がけ 編集者に対する心がけ 助言はよく聞こう 自分の状況を正しく伝えよう 感謝の気持ちを忘れな

  • Javadocを書かない - しげるメモ

    前回はJavadocを書く - しげるメモというタイトルで話を進めましたが、今回は逆にJavadocを減らすプラクティスについてメモがてら。 私は別にJavadocを書くのが好きなわけではなく、単純に書いたほうがめんどくさくないと思うのでそうしてます。ただ、Javadocを書くのもかなりめんどくさいとは自分自身で感じているので、そのめんどくささをできるだけ減らす道を現在も模索中です。 やり方としては単純で、次のうちどちらかです。 Javadocをそもそも書かない Javadocに書くことを減らす かなりの部分がEffective Java (Java Series)に紹介されているプラクティスとかぶりますが、ここではあくまで"めんどくさくないJavadoc"という視点でいきます。 Javadocをそもそも書かない If an API is to be usable, it must be

    Javadocを書かない - しげるメモ
  • 身も蓋もないが本当に有効な「論文の書き方」 - 発声練習

    CAREERzine:身も蓋もないが当に有効な「企画書の書き方」のフォーマットパクリです。 前例を重視する 論文には内容と結果、主張の独自性は求められますが、形式については独自性を求められません。むしろ、独自性が高く前例にしたがっていない論文はダメな構成の論文であるとみなされる傾向にあります。 企画書を書くとき、とくに、異動したてであるとか、新しい仕事であるとか、そういう場合は必ず、その部門での企画書に目を通しておくべきです。どういう順番で書いてあるか、どこを手厚くしているか、などに着目していきましょう。あるいは、前例となる企画書をフォーマットだと思って文章を上書きしていくのも有効です。 (CAREERzine:身も蓋もないが当に有効な「企画書の書き方」より) 研究テーマや投稿先の学術雑誌、国際会議によって論文が通りやすいフォーマットというのが決まっていることが多いです。必ず投稿先の学

    身も蓋もないが本当に有効な「論文の書き方」 - 発声練習
  • steps to phantasien t(2007-07-06)

    昔の同僚が退社してベンチャー仕事をやるという. 門出を祝う宴会に, 昔のよしみで呼んでもらった. ついでに古巣の近況を聞く. ひとつ嬉しい知らせがあった. 以下その自慢話. ある夏, 私は社内ライブラリのチュートリアルを書いた. そのチュートリアルが, 今でも改訂されながら参照されているという. のみならず新人プログラマの研修教材として広くとりいれられつつあるそうだ. 私はとても嬉しくなった. もちろん手柄は改訂を続け, 様々な改善を続けた彼らのものだ. それでもなお私は喜びを隠せない. 自分が去った今も文章だけが生き続けている. 私は平凡なプログラマだから, 自分のコードが生き残れるとは思えない. 一方ボランティアで仕事の合間に書いた文章は読み継がれている. 価値のあるものが生き残るのなら, 私のなした価値は(コードではなく)文書にあったことにある. プログラマとしては悲しいけれど, 会

    drumsco
    drumsco 2007/07/09
    どんなドキュメントを準備し、どう展開していくと良いかというtips
  • 「読みやすい文書」をMS-Wordで楽しく!!

    「文字」はさまざまな「情報」を伝えるベースとなるものですが,それを使って文書を作成する場合には基的なルール,「組版(くみはん)ルール」があります。 組版ルールは「きれいで読みやすい文書」を作るためのものです。 DTPシステム等で製作されたや雑誌の組版を意識して見ていけば,どんなに読みづらいものが多いかお分かりいただけるはずです。 「組版ルール」を踏まえて次ページより,MS-Wordでビジネス文書を作成するときに気をつけたい点について記していきます。 さあ,あなたもプロの組版技術を身につけてみませんか。 ※WindowsWindowsNT,MS-Wordは米国MicrosoftCorporationの米国及び他の国における登録商標です。 ※Macintoshはアップルコンピュータ社の商標です。 ※その他記載の会社名および商品名は各社の商標または登録商標です。 ※当コーナ

    drumsco
    drumsco 2006/11/29
    モトヤフォントの会社の文章
  • 論文の書き方

    論文の書き方 1997年1月 論文の書き方 1.論文書きの手順 (1)論旨の組み立て (2)アウトライン 「はじめに」の書き方 「問題意識」の書き方 「研究のアイデア」の書き方 「実験」の書き方 「まとめ」の書き方 2.文章技術 トピックセンテンス 逆茂木型の文章 論理の鎖 例中心主義 3.文章を書く心得 千葉 滋 (Shigeru Chiba)、東京大学

  • 1