Design Doc 的な何か用の Wiki 記法によるテンプレ [日記] はるか昔[2007-05-05-3]に、Googleの技術講演会でソフトウェア開発体制について講演されたことに言及しました。そのときはDesign Docが結局どんな感じなのか、は分かってませんでした。今回は、Design ... 続きを読む
字を書いて、相手に伝える。それだけなのに、これがとても難しい。 想いはどうしたら相手に伝わるのか。考えても考えても、未だに答えは出ていません。 ですが幸いなことに、毎日3,000人以上の方が、私の文章を読みに来てくださっています。これはとてもとても... 続きを読む
先月書いた以下の仕様書公開記事が好評だったので、先週リリースしたCSSのインデントを綺麗にするサービス「SASSIENCE」の仕様書を公開してみる。個人で作ったWebサービスの仕様書(Evernoteのメモ)を2つ公開してみる今回も、前回公開した2つの仕様書とほとん... 続きを読む
このページは、プログラムやコードなどの主に技術文書を書く方々のために、分かりやすい文章を書くためにはどうすればよいのかについて説明しています。 自分が伝えたいこと・訴えたいことを誤解しないように相手に読んでもらうにはどうするべきか。 文章を書く... 続きを読む
某氏……に限らず,巷でドキュメンテーションを嫌がっている向きが典型的に口にすることに,次のような話があります。 ソースを読めばなんでも分かる。バグもすべて書いてある。 以前もこの話を書いたかもしれないけれど,この命題は非常にトリッキーで詭弁的だ... 続きを読む
コミュニケーション , 仕事術 ライティングスピードを向上させるための4つのコツ 2011.03.03 10:00 コメント数:[ 0 ] Check Tweet Photo by laffy4k. メール、プレゼン資料、研究報告書、などなど...。私たちは、日々職種を問わず「モノを書く」ことに多くの時... 続きを読む
開発現場であってもそうでなくても議事録を書く機会は多いのですが、意外に役にたつ議事録を書くのは難しいものです。ということで、以下自著『プロジェクトを成功させる現場リーダーの技術』より議事録の書き方をまるっと引用。キーワードは「目的・課題・アク... 続きを読む
2011年02月07日 02:53 カテゴリプロジェクトデザイン プロジェクト推進者のための議事録の書き方 Posted by fukuidayo プロジェクトを設計(デザイン)し、前に進める。という仕事に取り組み始めてから、ありがたい事に多くの仕事の相談や依頼を受けるようにな... 続きを読む
ITエンジニアにとって文書作成技術は欠かせません。日常のメールのやりとりにはじまり、要件定義書、機能仕様書、企画の提案書など、上司やチーム、顧客などに対して、文章でコミュニケーションをとる機会がとても多いからです。 連載『悪文と良文から学ぶロジ... 続きを読む
Loading… Flash Player 9 (or above) is needed to view presentations. We have detected that you do not have it on your computer. To install it, go here. Smell in Rails Apps (in Sapporo RubyKaigi03) - Presentation Transcript Smell in Rails Apps... 続きを読む
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方 目次 この文書について 設計文書のうまい書き方 なぜ設計文書を書くのか 良い設計とは何か 同僚の開発者に向けて書く 第 1 節に書くこと: プロジェクト/サブシステムの目的を示す 第 2 節に書く... 続きを読む
『坊っちゃん』自筆原稿 読みやすい文章とは、流れるように読める文章だ。難しい言葉はいらない。気のきいた言葉もいらない。文頭から文末まで振り返ることなく読める文章が、最も美しい。読みやすさの基準は客観的なものだ。読み手には様々な人がいる。老若男... 続きを読む
研究者を対象にした学会発表や研究室のゼミ発表、研究者でない人を対象としたアウトリーチ活動などの科学コミュニケーションにおいて、研究者や学生は、自身の成果やアイデアを「正確に」かつ「効果的に」伝える必要があります。これらのことを意識せず、ただ闇... 続きを読む
_ ChangeLog の作法 つづき Subversion の開発者が ChangeLog について面白い記事を書いている. 記事の要旨はこうだ: ChangeLog (Subversion なので commit log) を書くのは面倒だよ, メーリングリストもあることだし書かなきゃダメ? ってよく訊かれる. 書きま... 続きを読む
[-]=======================================================================[-] Wizard Bible vol.34 (2007,6,12) [-]=======================================================================[-] x0xXx0xx0xXx0xx0xXx0xx0xXx0xx0xXx0xx0xXx0xx0xXx0xx0xXx... 続きを読む
ITエンジニアにとって文書作成技術は欠かせません。日常のメールのやりとりにはじまり,要件定義書,機能仕様書,企画の提案書など,上司やチーム,顧客などに対して,文章でコミュニケーションをとる機会がとても多いからです。 本連載では,論理的にわかりや... 続きを読む
文章力の基本 日本実業出版社 2009-07-24 売り上げランキング : 1127 おすすめ平均 Amazonで詳しく見る by G-Tools 本書はとてもやさしくて、よい本です。 「文章力を鍛える本」というと、必要以上に厳しかったり難しかったりするものですが、本書にはそういう... 続きを読む
2009-12-04 サポートエンジニアが経験から語る、論理的文章によるコミュニケーションのススメ 俺はこれまで一貫してIT業界でエンジニアとしてのキャリアを進んできたのだが、これまでのキャリアでもう一つ一貫していることがある。それは、ずっとサポートエンジ... 続きを読む
■ 駄目な技術文書の見分け方 その1 はてなブックマークのホッテントリを見ていたところ、300を超えるユーザに登録された以下の記事があった。 今夜分かるSQLインジェクション対策, 上野宣, @IT, 2006年11月2日 また上野宣か。顔見知りなのでズバリいくことにす... 続きを読む
PHPの文字エンコーディングの入力チェックを改善する方法について日本語のブログで議論があり、そのパッチを本家に提案したが、却下された、という話が盛り上がっているようです。 バグレポートされた岩本さん自身や、コメント欄やはてなブックマークでは、 PHP... 続きを読む