ドキュメントを書くときの「メンタルモデルの原則」 - クックパッド開発者ブログ
こんにちは。クリエイション開発部の丸山@h13i32maruです。 みなさんドキュメント書いてますか？私はドキュメントを書くのは結構好きです。最近もプライベートで開発しているJasperというGitHub用Issueリーダーのユーザ向けドキュメント（マニュアル）を書きました。でも良いドキュメントを書くのって難しいですよね。 そこで、本記事では「ツールやライブラリなどを対象にしたユーザ向けドキュメント」を書くときに私が考える原則を紹介します。ちなみに私はテクニカルライティングの専門家ではなく、普通のソフトウェアエンジニアです。そのあたりはいい感じに汲み取っていただけると🙏 🕵️メンタルモデルの原則 良いドキュメントとはどのようなものなのでしょうか？私は「そのツールやライブラリに対して読者がメンタルモデルを構築できる」のが良いドキュメントだと考えています。これを「メンタルモデルの原則」と呼
コロナに乗じて町内会の属人業務を改善しまくった一人のおばあちゃんの話
町内会のおばあちゃんの話をします。 しんざきは町内会というものに所属しています。 以前マンションの理事長に持ち回りで就任した時、セットで町内会にも所属することになりまして、それ以降なにやかやでちょくちょく顔を出すようになりました。 町内会の青年団というものに「青年」など一人も所属しておらず、40歳のおっさんである私がほぼ最年少だ、ということにショックを受けたりもしていました。 この年になって「十数人のグループで最若手」になる機会があるとか、思ってませんでしたよ正直。 この町内会に、いつも電動自転車で町内を軽快に走り回っている、一人の名物おばあちゃんがいます。 もう御年は80歳を何年か過ぎていらっしゃると思うんですが、一時期体調を崩しつつもおおむねお元気で、物凄く新しい知識に貪欲で、ITスキルについても全く抵抗感というものがなく、町内会で数々の業務改善を成し遂げてきた凄いおばあちゃんでして。
時間をかけて、つまらないものを作りたいか？ - futoase
時間をかける つまらない想像話を以下に書く。 失敗してはいけない。成功しなければ行けないプロダクトだ。 企画から色々と実装アイディア、目的とするユーザー像を聞いている。 それに見合ったシステムを実装しなければならない。 あと6ヶ月で。その間は徹底的に企画と話をする。 部長と話しをして、駄目だったら作りなおす。 6ヶ月の間、エクセル上にガントチャートを引き、開発スケジュールを引いた。 企画・営業は2名。そのうち1名はマネージャ的な担当を行う。 部長は最終決定を下す(と聞かされている)。 エンジニアは3名。チームとしてはまあ良いほうだろう。 3ヶ月後 何を作っているのかわからなくなってきた。 具体像もわからない。 エクセルに書いたガントチャートは、意味を成していない。 ガントチャートを直そうと思うと、他の予定もずらさなければいけなくなり、 だるくなってだれも更新しようとしない。 システム全体の
Webデザイナーさん、デザインを複数案作るとき、どんなことに気をつけてますか？
☆ご注意☆ この記事は 2011年7月23日 に書いたものです。情報が古い可能性がありますのでご注意ください。 デザイン案についていつも考えてる事、悩んでる事などをまとめてみました。 いつも孤独に作業してるので一般的にどうしてるのか知りたい！！ デザイン案っていくつ作ってますか？ 私は毎回2案作っています。 理想としては2～4案だと思うのです。 でもちょっと今の環境では時間的、コスト的に2案出すのが限界で、、、(´・ω・`) 前の制作会社にいたころはデザイナーの人数も多かったので3人×2案の6案、コンペ形式っていうのもありました。 同じトップページでもデザイナーによって同じ条件でも出来上がるものは全く違いますから、自分とはぜんぜん違う方法で表現したりしていて、デザイナー同士もすごく勉強になって、個々の引き出しが増える技術力UPになります。 クライアントにとっても、たくさん判断材料があるし、
職種ではなく自分として仕事をするためのヒント
先週末、パンダの会 その陸が開催されました。5月に @3panda さんと対談をしたことがキッカケで実現した今回のイベント。パンダの会は Web サイト制作をはじめてまだ 1, 2年くらいの方を主な対象としていますが、この日はおなじみの顔ぶれもチラホラあり、リラックスした雰囲気で行われました。今回のお題は『Webをつかって何をしたいか見つけ出そう』。先月開催された WebSig 1日学校では、多くの先生がキャリアについてお話されていましたが、私はパンダの会でキャリアについて話すことになりました。 2006年に流行していた言葉や技術を前面に押し出してアピールしている企業や個人はいるでしょうか。2011年のトレンドも同じようなことになるでしょう。 Webは動きが目まぐるしく、トレンドについていくのが精一杯になりやすいところから、数年先を見据えたプランが立てれないことがあります。誰もが予測は出来
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
