[B! ドキュメント] paulowniaのブックマーク

paulownia id:paulownia

ドキュメントに関するpaulowniaのブックマーク (9)

ボードゲームの説明書に学ぶ、「伝わる」引き継ぎ資料の作りかた　実践編｜ミヤザキユウ／ボードゲームデザイナー
引継ぎ資料を作るときには、ボードゲームの説明書の作り方を真似しましょう。すると誰でも分かりやすい資料ができて、後任の人がハッピーになって、感謝されて、あなたもハッピー。本 noteでは、そんなハッピーを生み出すために、ボードゲームの説明書の構造 & 引き継ぎ資料への作り方を解説していきます。ゲームを作る方なら、説明書をデザインするときも参考になるかもしれません。まずは実際の説明書を見てみましょう。下記の画像は、僕が以前つくった「切り裂きジャックは誰？」というゲームの説明書です。「B5１枚に収める＆フォントは最低でも7pt」という制約のため詰め込み気味ですが、内容は結構わかりやすくなっているかと思います。これを踏まえて、各項目について解説していきます。１．ゲームの名前おそらくどんな説明書でも、最初に書かれているのはそのゲームの名前ではないでしょうか。引き継ぎ資料も同様に、最初は
paulownia 2018/01/28
ドキュメント

文章
リンク
[AWS] 構成図作成ツール「Cloudcraft LIVE」を触ってみた - Qiita
こんにちは！楽して、かっこよく、AWSの構成図かけないかなーっとぽちぽちネットで調べていたところ、AWSの構成情報を読み取って構成図作ることができる素晴らしいツール「Cloudcraft LIVE」がヒットしてきたので試してみました。 1.Cloudcraftで準備① それでは、進めていこうと思います。まずCloudcraft上での事前準備があるのでやっていきます。・Cloudcraftにログインして、左上の[LIVE]をクリックします。 Googleのアカウントを使ってログインすることもできます。・左上の[ADD AWS ACCOUNT]をクリックします。・Cloudcraft用のRead onlyロールを作成してと言われるので、再度[ADD AWS ACCOUNT]をクリックします。・ロールの作り方の手順が表示されますので、一旦この画面を表示させながらAWSコンソールでの作
paulownia 2016/08/13
ドキュメント

AWS
リンク
Google の Design Doc について - フリーフォームフリークアウト
移転しました http://please-sleep.cou929.nu/20091116.html
paulownia 2013/10/18
開発

ドキュメント
リンク
コマンドラインオプション - JsDoc Toolkitを使う！
サンプルの動作環境についてこのページに記載されているサンプルは、以下の動作環境を想定しています。 OS：Windows (コマンドプロンプト) JRE：JRE 6 ※「%JREインストールディレクトリ%￥bin」にpathが設定済みとするカレントディレクトリ：JsDoc Toolkitのインストールディレクトリ記述例 java -jar jsrun.jar app\run.js c:\example\js\ -t=templates\jsdoc -d=c:\out\example -a JsDoc ToolkitはJavaで実装されたJavaScript実行環境である"Rhino"上で動作します。RhinoはJsDoc Toolkitの配布パッケージに含まれており、実行アプリケーション"jsrun"から起動されます。そしてjsrunはJsDoc Toolkitのメインスクリプトである
paulownia 2010/02/27
javascript

ドキュメント

ツール
リンク
Javadoc の書き方 - イトウアスカ blog
みなさん、Javadoc 書いてますか？　Javadoc は「API ドキュメント」と言われることが多いように、主にライブラリ的なプログラムで書いてこそのものだと思っている方もいるかもしれません。しかしながら、仕様書を Word や Excel（笑）で別途作ると、プログラムと仕様書の同期がとれてないというはめに陥り易くなりますので、Javadoc はどんなときも活用したいというのが私の考え方です。まず、overview.html を書け Javadoc コメントをいくらか書くような人でも、overview.html を書く人は意外と少ないのではないでしょうか。リファクタリングが何度となく行われるアジャイル開発の現場では、クラスの構成がよくかわりますので、いちいち詳しいコメントを書いていられないということはあるかもしれませんが、overview.html はそれほど何度も手をつけるようなも
paulownia 2009/05/20
開発

Java

ドキュメント
リンク
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方目次この文書について設計文書のうまい書き方なぜ設計文書を書くのか良い設計とは何か同僚の開発者に向けて書く第 1 節に書くこと: プロジェクト/サブシステムの目的を示す第 2 節に書くこと: 設計に使う高レベルなエンティティを定義する第 3 節に書くこと: 個々のエンティティに関する低レベルの設計を書く使い方設定モデル相互作用第 4 節に書くこと: 利点, 前提, リスク/懸念事項マネージャ向けに書くこと最後に設計文書のうまい書き方この文書について "How to Write an Effective Design Document" の日本語訳です. http://blog.slickedit.com/?p=43 推敲歓迎: 誤訳, タイポ, 訳語の不統一,
paulownia 2007/09/25
ドキュメント

開発
リンク
マニュアル作成が１０倍楽になるソフトがありました｜WEBクリエイターの木
10分で作るRailsアプリという動画がRuby on Railsのすばらしさを短時間に説明してくれましたが、動画の説明は何より説得力がありますよね。画面キャプチャを何枚も貼って文章で説明するよりも、目で見て、間を体験すると感じるものがあります。何より見る方は楽。作る方も楽だったらなあとも思います。以前自分の設計したWEBアプリのマニュアルを、パワーポイント 100ページ以上の膨大な資料としてまとめたことがあります作りながらも「こりゃあだれも見ないだろうなあ。自分でもみないもの」と思いながらも、提出義務があって仕方なく作っていました。印刷したお客さんからは「紙の無駄だ」と怒られわ、HTML化してWEBアプリに「ヘルプ」をつけても電話がかかってくるのが先でした。しかしそんな苦労に遭わないように、最近お宝を発見しましたその名も「Adobe Captivate2」まあまあとりあえずア
paulownia 2007/03/07
仕事

ドキュメント
リンク
ドキュメントを作成しないユーザーは、失敗する − ＠IT情報マネジメント
ドキュメントを作成しないユーザーは、失敗する：ユーザーサイド・プロジェクト推進ガイド（15）（1/2 ページ）システム開発にドキュメントはつきものだ。しかし、しばしばドキュメントが作られないプロジェクトが見られる。ドキュメントがないとどのような事態が発生するのだろうか？コンピュータ・システム開発プロジェクトにおいて、ユーザーサイドではどのようなドキュメントが作成、準備されているのでしょうか？対象業務の概要を個条書きしたもの、現状使われている伝票や帳票類、現行システムのソフトやハードの構成図、それに画面のハードコピー、もしくは完成図書一式を資料として用意すれば十分でしょうか？あとは打ち合わせの中でベンダへ口頭で伝えればよい──といえるでしょうか？関係部署が1つか2つ程度で限られた業務だけを対象とする小規模なシステム、あるいは現行システムの単純な更新であれば、この程度の資料だけで間に
paulownia 2006/09/16
開発

マネジメント

ドキュメント
リンク
ドキュメントレビューに役立つ40のチェックポイント ― 1/3 ― ＠IT情報マネジメント
プロジェクトを進めるうえで、トラブル発生による手戻りを未然に防止するほかに、進ちょくを測ったり、リスクを予測したりするためには、ドキュメントレビューが効果的である。ここでは、主要なドキュメントに対するチェックポイントを紹介する。仕様書のチェックリスト以下に仕様書の基本的なチェックポイントを紹介する（なお、第4回の「急がば回れ──質の良い仕様書の作り方」も併せて参考にしていただきたい）。ソフトウェア開発というのは、意図するところを人間の言葉からいくつかの成果物（ドキュメント）を経て、コンピュータの言葉に置き換えるバケツリレーのようなところがある。最初にこぼれた水を途中でつぎ足すことは、なかなか難しいもの。早い段階──仕様書には“漏れ”がないようにしたい。（1）題名は、システム名を明記しているか仕様書の題名に「?システム仕様書」のように、システム名が明記されているか。“名は体を表す”
paulownia 2006/01/25
開発

ドキュメント
リンク
1