【社内資料公開】運用手順書を作る時のポイントについて書いてみた | DevelopersIO
はじめに こんにちは植木和樹＠上越妙高オフィスです。本日は私がここ10年くらい意識している運用手順書を書くときのポイントについてまとめてみました。 対象読者 開発・構築したシステムを別の人に引き継ぐ予定のある人 他の人が作ったシステムを引き継ぐ担当の人 半年後の自分でも分かる手順書の書き方に困っている人 （この記事を読むのにかかる時間の目安：5分） 1. ドキュメントの冒頭に書くこと まず個々の詳細手順の前に、ドキュメント自体について記載してもらいたいことです。 1.1. ドキュメントに書かれていることを3行で書く ドキュメントの最初には、このドキュメントに何が書かれているのかを100文字くらいで書いておくと良いでしょう。 システムが増えれば増えるほど手順書も増えていくものです。見つけたドキュメントに自分の期待するものが書かれているのか、冒頭数行でわかるようになっているとうれしいです。 1
システム開発の仕様書テンプレートや参考サイトのまとめ｜IT情報局
システム開発の際に必要になる要求仕様書や基本設計、詳細設計に使う各種の書類のテンプレートを紹介しているサイトをまとめました。 また、参考になる資料を配布しているサイトや開発関連資料の書き方などの説明をしているサイトもあります。 システムを開発時の書式や方法は各プロジェクトによって使うフォーマットは異なりますが、初めて開発する場合や自社での開発資料を作成する際のテンプレートとして参考にしてください。 2017/2/22 追記 リンク先の資料を配布しているサイトがかなり古くなってしまったのでリンクの見直しと、新たにシステム開発の資料を提供しているサイトを探して追加しました。 仕様書のダウンロードができるサイト Pocket 9 要求仕様書から見積、基本設計、詳細設計、コーディング規約、テスト仕様書、その他スケジュールや議事録まで システム開発に必要な書類のテンプレートがそろっています。 htt
西崎義展の手記
この企画書は、西崎義展氏から預かったものです。 今のようにワープロがなかった時代に、「漢字タイプ」で一文字ずつ打ち込み、 カラー印刷できなかったので（当時は高価だった）、１冊ずつ手作りで、合計１０冊を 作るのが精一杯だったそうです。 この企画書を持ってテレビ局に行き、ゴーサインが出た後に、監督や、デザインなどの スタッフを決めたそうです（後述）。 これが幻の企画書の表紙です。 何度か雑誌で公開されたのでご存じの方も多いでしょう。 ここで注目していただきたいのは、タイトルの字体が現在も （映画やテレビで放映されたものと）変わらないことです。 写真の下に 企画 西崎義展 山本映一 と書かれています。 以下、西崎氏の文章を引用します。 『まづ、最初に知って欲しいことは、この企画書は、十冊しか造られなかった。 （手に出来る者は）ＴＶ局は無論だが、初期に参加、又は、営業制作のメインスタッフに限られて
議事録作成が早くなると仕事が少しは楽しくなる（かもしれない）話 - インターネットの備忘録
会議が終わった瞬間に議事録を出さないと何かこうトイレに行ったあと拭いてないみたいなキモチワルさが残るはせおやさいです、いかがお過ごしですか。 新入社員が最初にぶつかる壁の一つに「議事録作成に時間がかかる」があるんじゃないかなって思ったのと、議事録出せ出せ言われてもなかなか出せないのってチーム全体のストレスになるのでこういうふうにやるといいよ的なTipsを備忘します。 議事録の目的 参加者全員の備忘録 言った言わないを防ぐための予防 同席していない人への情報共有 あたりでしょうか。 あるのとないのとだと、1000％あった方がいいです。 そして議事録がちゃんと積み重なってログになってるプロジェクトの方が、うまくいく確率が格段に上がります。経験談です。マジです。 わたしは人間の記憶力はアテにならないことを信条としているので、自分も、そして相手も言ったことを忘れるものだという前提で、何があっても付
Joel on Software - やさしい機能仕様 - パート 1: なぜわざわざ書く必要があるのか?
Joel Spolsky ジョエル・スポルスキ 翻訳: Yasushi Aoki 青木靖 2000/10/2 The Joel Testを発表したとき、読者から寄せられた最大の不満の種は、仕様書を書かなければならないということだった。仕様書はデンタルフロスみたいなもので、みんな書かなきゃいけないと思ってはいるが、誰も書かない。 なぜ人々は仕様書を書きたがらないんだろう? 人々は仕様書作成フェーズを飛ばせば時間を節約できると主張している。彼らは仕様書作成がNASAのスペースシャトルのエンジニアか巨大な保険会社で働いているような人たちのための贅沢品であるかのように振舞っている。戯言だ。何よりも仕様書を書かないというのは、あなたがソフトウェアプロジェクトに持ち込む、最大かつ不必要なリスクである。それは着替えだけリュックに詰めて、その場になれば何とかなることを期待してモハーベ砂漠の横断に出発するの
最低限知っておきたい仕様書を書くときの３つのポイント 【ボクバイＺ the blog】
こんにちは。ライブドアでブログを更新しているキツネハンターです。 今回はソフトウェア開発に必要となる「仕様書」を書く際のポイントについて紹介したいと思います。あと、このテイストはlivedoor ディレクター Blogのパクリです。 さて、仕様書と言っても、大別して２種類あることをご存知でしょうか？１つはユーザー側から見た外部仕様（機能仕様）、もう１つは開発者側から見た内部仕様（技術仕様）です。 例えば、「0〜100までの素数を全て求めたい、素数を数えて落ち着くんだ」というのが外部仕様。これに対して、「ある数Ｘ（Ｘは0以上、100以下）を２からＸまで順に割ってアレする」というのが内部仕様。 外部仕様を書くのはカンタンです。たぶん、誰でも書けます。でも、内部仕様を書くのはプログラミングのスキルがないと書けません。内部仕様を書けるのは、プログラマーかスーパープランナーだけです。 ボク
dfltweb1.onamae.com – このドメインはお名前.comで取得されています。
このドメインは お名前.com から取得されました。 お名前.com は GMOインターネットグループ(株) が運営する国内シェアNo.1のドメイン登録サービスです。 ※表示価格は、全て税込です。 ※サービス品質維持のため、一時的に対象となる料金へ一定割合の「サービス維持調整費」を加算させていただきます。 ※1 「国内シェア」は、ICANN(インターネットのドメイン名などの資源を管理する非営利団体)の公表数値をもとに集計。gTLDが集計の対象。 日本のドメイン登録業者(レジストラ)（「ICANNがレジストラとして認定した企業」一覧（InterNIC提供）内に「Japan」の記載があるもの）を対象。 レジストラ「GMO Internet Group, Inc. d/b/a Onamae.com」のシェア値を集計。 2023年5月時点の調査。
ブロック図生成ツール blockdiag — blockdiag 1.0 ドキュメント
ブロック図生成ツール blockdiag¶ blockdiag シリーズはシンプルなテキストからブロック図などの画像を生成する画像生成ツール群です。 blockdiag を用いると以下のような図が簡単に生成できます。 blockdiag の主な機能: 数種類の図に対応 ブロック図 (blockdiag コマンド) シーケンス図 (seqdiag コマンド) アクティビティ図 (actdiag コマンド) 論理ネットワーク図 (nwdiag コマンド) テキストベースの定義ファイルから画像ファイルを生成 (graphviz 風の文法を採用) 定義にあわせて図の配置を自動的に決定 (自動レイアウト) Sphinx, Trac, Redmine, 各種 Wiki エンジン等、多様なシステムへの画像埋め込みに対応 Enjoy documentation with blockdiag !
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
Overview — Sphinx v1.0 (hg) documentation
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
「はてな教科書」をiPadやKindleで見れるようにPDFにして公開しました | Act as Professional
企業が研修資料を公開する文化が広まれば良いな。と思う@HIROCASTERでございませう。 「はてな教科書」をgithub上に公開しました – Hatena Developer Blogこの記事で、「はてな教科書」がMarkdown形式でGithubに公開されたので、これをiPadやKindleでも見れるようにPDFにしました。 Perl によるオブジェクト指向プログラミング ORM によるデータベース操作 (DBIx::MoCo を使った開発) MVC によるウェブアプリケーション開発 (Ridge を使った開発) JavaScript によるイベントドリブン僕もgithubに公開しています。 hirocaster/Hatena-Textbook · GitHubデジタルガジェットで、通勤中にでもお読みください。
総務省 情報通信政策研究所（IICP）
研究成果～調査研究報告書（平成22年(2010年)以前） 調査研究報告書（平成23年(2011年)以降） 平成22年（2010年） 平成21年（2009年） 平成20年（2008年） 平成19年（2007年） 平成18年（2006年） 平成17年（2005年） 平成16年（2004年） 平成15年（2003年） 平成22年（2010年） 「情報通信産業の経済動向報告」 ２０１０年第４四半期（10－12月期）（PDF:761KB） ２０１０年第３四半期（７－９月期）（PDF:451KB） ２０１０年第２四半期（４－６月期）（PDF:778KB） ２０１０年第１四半期（１－３月期）（PDF:1.28MB） 「メディア・ソフトの制作及び流通の実態」 調査結果（PDF:857KB） 「情報流通インデックス」 調査研究結果（PDF:394KB） 「IDビジネスの現状と課題に関する調査研究」 概要資料
copyright-jp
お知らせ SIST(科学技術情報流通技術基準)事業は2011年度末に終了し、ウェブサイトは現在、公開は終了しています。 当サイトは、独立行政法人科学技術振興機構とは関係がありません。 国立国会図書館において、SIST(科学技術情報流通技術基準)事業のウェブサイトのコンテンツが保存され、公開されています。 SIST(科学技術情報流通技術基準)（国立国会図書館 保存） https://warp.ndl.go.jp/info:ndljp/pid/12003258/jipsti.jst.go.jp/sist/index.html 参照文献の書き方S I S T 0 2 - 2007 *1 *1 出典：「参考文献の役割と書き方 科学技術情報流通基準(SIST)の活用」科学技術振興機構(JST) https://jipsti.jst.go.jp/sist/pdf/SIST02-2007.pdf(PDF
詳しすぎる詳細設計書 - SiroKuro Page
「詳細設計書」と呼ばれるドキュメントがあります。各処理の入出力や処理概要を記載した文章です。 入力： 「性別と身長のペア」のリスト 出力： 男性の平均身長」と「女性の平均身長」の差 処理概要： 変数「男性の合計身長」「女性の合計身長」「男性の人数」「女性の人数」を 0 で初期化する 入力を受け取る 入力されたリストから要素を読み込む 入力されたリストの要素数だけ以下を繰り返す 要素を１つ読み込み、条件分岐する もし要素が男性なら、変数「男性の合計身長」に身長を加算し、変数「男性の人数」を１増加させる もし要素が女性なら、変数「女性の合計身長」に身長を加算し、変数「女性の人数」を１増加させる 次の要素を読み込む 「男性の合計身長」÷「男性の人数」−「女性の合計身長」÷「女性の人数」を、変数「計算結果」に代入する 出力する イメージとしては、こんな感じ。各社それぞれ、どんな詳細設計書を書いてい
k-method.jp - このウェブサイトは販売用です！ - k method リソースおよび情報
This webpage was generated by the domain owner using Sedo Domain Parking. Disclaimer: Sedo maintains no relationship with third party advertisers. Reference to any specific service or trade mark is not controlled by Sedo nor does it constitute or imply its association, endorsement or recommendation.
要件定義の勘どころ
はじめに 役に立つシステムを構築するための要件定義書とは、いったいどういうものなのでしょうか。 「何でこの機能が必要なんですか？」「理由は分からないけどXXX機能があるのでこの機能が必要なんです。これがないとつじつまが合わなくなるんです」もしくは「要件定義書にこの機能が載っているので必要なんです」など、要件定義書の役割を理解しないまま、システムの開発に着手していることなどがないでしょうか。 本稿では、要件定義書の役割や重視すべき点、要件定義書に盛り込むべき情報について解説します。 何をやるのか、そしてなぜそうするのか 要件定義書はジグソーパズル？ システム開発を受託した会社にコンサルテーションしたときのことです。機能とデータがある程度記述された要件定義書を受け取ったその会社では、要件定義書を読み解き、システムの全体像を掴むためにおのおのの機能の関係を整理し、その役割を把握しようとしていまし
設計書仕様書テンプレート PocketDOC | 株式会社イーイノベーション
弊社サービスをご利用頂き、誠に有り難うございます。 ドキュメントのダウンロード件数が2007年5月の開設以来300000件を突破しました！ 今度ともご愛顧の程よろしくお願いいたします。 PocketDOC(ポケットドック)とはシステム開発に必要な設計書や仕様書などのドキュメントやテンプレートはもちろんのこと、 議事録、納品・検収書、近年話題になっている個人情報に関しての取扱管理表などの ドキュメントやテンプレートも提供しています。 実際に弊社のプロジェクトで使用されているため精度も高く、カスタマイズなしでも利用可能なほどです。 上流工程から下流工程まで広い範囲をサポートしているので、 必要なテンプレートだけをダウンロードして利用することも可能です。 ドキュメントやテンプレートのファイル形式はWord(doc形式)やExcel(xls形式)です。 ダウンロード後、すぐにお使いいただけるように
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
宇宙戦艦ヤマト 企画書
逆引き辞典
「要件定義」の4つの構造と依存関係に着目した実践手法
