河野 哲也 | キーワードベースドレビュー | ソフトウェアテストシンポジウム(JaSST) | 2010 | |
森崎 修司 | 間違いだらけの設計レビュー改訂版 | 日経BP | 2015 | https://www.amazon.co.jp/dp/482227747X |
著者 | タイトル | 出版社/発表機関 | 出版年/発表年 | 概要/参照先/特記事項など |
河野 哲也 | キーワードベースドレビュー | ソフトウェアテストシンポジウム(JaSST) | ||
森崎 修司 | 間違いだらけの設計レビュー改訂版 | 日経BP | https://www.amazon.co.jp/dp/482227747X |
#br
¶ISO/IEC/IEEE 29148:2011 | Systems and software engineering —Life cycle processes — Requirements engineering, | 2011 | 次の記載あり ・ステークホルダ要求(StRS),システム要求(SyRS),ソフトウェア要求(SRS)の構成例 ・要求構文の型 ・用語の留意点 ・要求の特性 ・要求言語の評価基準 to get the pdf |
ISO/IEC/IEEE 29148:2011 | Systems and software engineering —Life cycle processes — Requirements engineering, | 2011 | 次の記載あり ・ステークホルダ要求(StRS),システム要求(SyRS),ソフトウェア要求(SRS)の構成例 ・要求構文の型 ・用語の留意点 ・要求の特性 ・要求言語の評価基準 to download the pdf |
IEEE Std 1016-2009 | 1016-2009 - Redline Version IEEE Standard for Information Technology--Systems Design--Software Design Descriptions - Redline | 2009 | ソフトウェア設計書 to get the standard to download the 1998 version from |
ASDoQ会員は、次の編集方法に従って、システム開発技術の一覧を編集してください。
<wikiページの編集方法>
著者 | タイトル (リンク先は予備調査結果,WGメンバ参照可) | 出版社/発表機関 | 出版年/発表年 | 概要/参照先/特記事項など |
大西淳 | 要求工学 | 共立出版 | 2002 | http://www.kyoritsu-pub.co.jp/shinkan/shin0205_04.html |
幸地 司 | 外国人プログラマ向け設計書の留意点 | 2008 | http://gihyo.jp/magazine/emind/archive/2008/vol9 | |
塩谷敦子 他 | ソフトウェアドキュメンテーション | デンソークリエイト | 1999 | 開発プロセス内の各開発文書の役割と記述項目, テンプレート集, 好ましくない記述例と改善例あり. |
清水吉男 | 要求を仕様化する技術 表現する技術 | 技術評論社 | 2010 | |
竹内 広宜 他 | テキスト分析技術を用いた開発関連文書の品質分析 | 情報処理学会 組込みシステム研究会(組込みシステムシンポジウム) | 2009 | http://ci.nii.ac.jp/naid/110008746338 |
D.C. ゴーズ ,G.M. ワインバーグ | 要求仕様の探検学―設計に先立つ品質の作り込み | 共立出版 | 1993 | |
(社)日本情報システム・ユーザー協会 編 | 要求仕様定義ガイドライン(UVC研究プロジェクト報告書) | (社)日本情報システム・ユーザー協会(JUAS) | 2007 | |
花田收悦(編集責任) | ソフトウェアの仕様化と設計 | 日科技連出版社 | 1986 | 日科技連ソフトウェア品質管理シリーズ 第2巻 「第2章ドキュメンテーション」 ・仕様書の検証手順例の記載あり |
藤田 悠 他 | 組込みソフトウェア開発文書診断法 | 情報処理学会(情報処理学会研究報告,UB 25,1) | 2010 | |
山本修一郎 | ~要求を可視化するための~要求定義・要求仕様書の作り方 | ソフト・リサーチ・センター | 2006 | |
Ian Sommerville | Software Documentation | The revised version of Chapter 30 from the 'Software Engineering', 4th edition(Addison Wesley) | 2001 | to download the pdf, Software Engineering 9th edition(2010) Chapter 30: Documentation |
Karl.E.Wiegers | ソフトウェア要求 | 日経BPソフトプレス | 2001 | |
Springer | Requirements Engineering | Elizabeth, H.,Jackson, Dick, J. | 2002 | P.83, 4.8 に,要求文記述の構文テンプレートあり.P89,4.11 に,要求文書の評価基準の例あり |
ひな型の対象 | 名称 | 発表年 | 概要/参照先/特記事項など |
文書構造 | IEEE std.830-1998 | 1998 | 要求仕様書の目次例 |
Volere構造テンプレート | |||
Scenario plus | |||
文法 | EARS | 2010 | Easy Approach to Requirements Specification, RE2010, 2010 ・要求記述の文法 |
SVBR | 2008 | OMG, SBVR(Semantics of Business Vocabulary and Business Rules) v1.0, January 2008 ・ビジネス用語と規則の構造化英語 |
番号,略称など | 名称 | 発表年 | 概要/参照先/特記事項など |
ESPR | ESPR(Embedded. System development. Process. Reference) | 2007(ver.2.0) | 「[改訂版]組込みソフトウェア向け 開発プロセスガイド」(独)情報処理推進機構 ソフトウェア・エンジニアリング・センター(IPA SEC) to download the pdf |
CMMI | CMMI(Capability Maturity Model Integration): 『能力成熟度モデル統合』) | 2012(V1.3) | to download 日本語翻訳版「開発のためのCMMI (CMMI-DEV) 」 |
ISO/IEC/IEEE15289/D4, March 2011 | IEEE Systems and software engineering -- Content of life-cycle information products (documentation) | 2011 | システムおよびソフトウェア工学ーライフサイクル情報生産物(文書)の内容 |
ISO/IEC/IEEE 29148:2011 | Systems and software engineering —Life cycle processes — Requirements engineering, | 2011 | 次の記載あり ・ステークホルダ要求(StRS),システム要求(SyRS),ソフトウェア要求(SRS)の構成例 ・要求構文の型 ・用語の留意点 ・要求の特性 ・要求言語の評価基準 to get the pdf |
IEEE Std 830-1998 | IEEE Recommended Practice for Software Requirements Specifications | 1998 | 次の記載あり ・要求仕様の構成 ・要求仕様が満たすべき性質 to get the standard |
IEEE 1233-1996 | IEEE Guide for Developing System Requirements Specifications | 1996 | システム要求仕様書のガイド to get the standard |
IEEE Std 1016-2009 | 1016-2009 - Redline Version IEEE Standard for Information Technology--Systems Design--Software Design Descriptions - Redline | 2009 | ソフトウェア設計書 to get the standard to download the 1998 version from |
IEEE Std. 829-2008 | Standard for Software and System Test Documentation | 2008 | ソフトウェアテスト,システムテストの文書標準 |
ISO/IEC 15026-2:2011 | Systems and Software engineering—Systems and Software assurance | 2011 | システムとソフトウェアの保証(アシュアランス)ケースの構造と内容に対する最低限の要求を規定 |
番号,略称など | 名称 | 発表年 | 概要/参照先/特記事項など |
IEEE 1061 | IEEE Standard for a Software Quality Metrics Methodology | 1998 | |
ISO-IEC 9126 | Information technology software product evaluation:Quality characteristics and guidlines for their use | 1991 | JIS X 0129 ソフトウェア製品の評価-品質特性及びその利用要領 (X 0129-1 http://www.jisc.go.jp/ app/pager?id=7523) |
SQuBOK | SQuBOKガイド(Guide to the Software Quality Body of Knowledge) | 2007 | SQuBOK β版(v0.9.3.1) (β版後2007/12にオーム社から出版) |
番号,略称など | 名称 | 発表年 | 概要/参照先/特記事項など |
PMBOK | PMBOK Guide(A Guide to the Project Management Body of Knowledge) | 2013(Fifth Edition) | PMBOK Guide and Standards PMI日本支部 |
著者 | タイトル | 出版社/発表機関 | 出版年/発表年 | 概要/参照先/特記事項など |
河野 哲也 | キーワードベースドレビュー | ソフトウェアテストシンポジウム(JaSST) | 2010 | |
森崎 修司 | 間違いだらけの設計レビュー改訂版 | 日経BP | 2015 | https://www.amazon.co.jp/dp/482227747X |
日本語スタイルガイド第3版対応ATOK・Just Right! データ集 | TC協会・ジャストシステム | 2016 | https://www.jtca.org/standardization/index.html#23 |
日本翻訳連盟 標準スタイルガイド検討委員会 | JTF日本語標準スタイルガイド 第2.0版 | 日本翻訳連盟 | 2012 | 実務翻訳業界での外国語から日本語に翻訳する際の日本語表記ガイドライン 最新版はJTF日本語標準スタイルガイド 第2.0版(2014.2) |
日本翻訳連盟 標準スタイルガイド検討委員会 | JTF日本語標準スタイルガイド 第1.2版 | 日本翻訳連盟 | 2012 | 実務翻訳業界での外国語から日本語に翻訳する際の日本語表記ガイドライン 最新版はJTF日本語標準スタイルガイド 第1.2版(2013.6) |
APA(アメリカ心理学会) 訳:江藤 他 | APA論文作成マニュアル | 医学書院 | 2004 | “Publication Manual of the American Psychological Association”, 5th editionの翻訳版.英語論文の作成マニュアルだが、日本語の技術文書作成にも参考となる部分が多い |
清水 久三子 | プロの資料作成力 | 東洋経済新報社 | 2013 | |
清水 久三子 | ロジカル・ライティング | 日経文庫 | 2013 | 第4章まで共通的な基本が述べられており、残りの4章で、共有文書(議事録、告知文書)、報告文書、依頼文書、説得文書の書き方が各論として説明されています |
テクニカルコミュニケーター協会 | 日本語スタイルガイド | テクニカルコミュニケーター協会出版事業部会 | 2009 | テクニカルライティングの基本を押さえるためのガイドブック 2013.1に第2版が発売された |
APA(American Psychological Association) | Publication Manual of the American Psychological Association | American Psychological Association | 2001 | 2011のASDoQ調査時には第6版まで発行 |
APA(アメリカ心理学会) 訳:江藤 他 | APA論文作成マニュアル | 医学書院 | 2004 | “Publication Manual of the American Psychological Association”, 5th editionの翻訳版.英語論文の作成マニュアルだが、日本語の技術文書作成にも参考となる部分が多い |
テクニカルコミュニケーター協会 | 日本語スタイルガイド | テクニカルコミュニケーター協会出版事業部会 | 2009 | テクニカルライティングの基本を押さえるためのガイドブック 2013.1に第2版が発売された |
ASDoQ会員は、次の編集方法に従って、文書作成技術の一覧を編集してください。
<wikiページの編集方法>
著者 | タイトル (リンク先は予備調査結果,WGメンバ参照可) | 出版社/発表機関 | 出版年/発表年 | 概要/参照先/特記事項など |
雨宮 拓 | テクニカルコミュニケーションにおける日本語スタイルガイドと表現手法の変化 | 情報処理学会(情報処理学会研究報告,DD 2010-DD-77(1), 1-3) | 2010 | |
阿部 圭一 | 明文術 伝わる日本語の書きかた | NTT出版 | 2006 | 情報伝達型の日本語文章の書き方一般を説明している。コミュニケーションのプロセスの説明から始めていることが特徴 |
阿部 圭一 | 情報伝達型の日本語文章・文書にたいするガイドラインの策定に向けて | 未定稿 (ASDoQ大会配布資料) | 2012 | 付録に「情報伝達型の文章術に関する本が採り上げている事項の比較」 |
APA(American Psychological Association) | Publication Manual of the American Psychological Association | American Psychological Association | 2001 | 2011のASDoQ調査時には第6版まで発行 |
APA(アメリカ心理学会) 訳:江藤 他 | APA論文作成マニュアル | 医学書院 | 2004 | “Publication Manual of the American Psychological Association”, 5th editionの翻訳版.英語論文の作成マニュアルだが、日本語の技術文書作成にも参考となる部分が多い |
石黒圭 | 論文・レポートの基本 | 日本実業出版社 | 2012 | |
大石 哲之 | 伝達力の基本 | 日本実業出版社 | 2011 | |
大島弥生, 池田玲子, 大場理恵子, 加納なおみ, 高橋淑郎, 岩田夏穂 | ピアで学ぶ大学生の日本語表現・プロセス重視のレポート作成 | ひつじ書房 | 2005 | レポート作成を初めて体験する人を対象として,課題レポートを作成する過程に沿って学習することを想定した内容 |
克元 亮 | SEの文章術 | 技術評論社 | 2007 | 技評SE新書010 |
岸 学 編 | 文書表現技術ガイドブック | 共立出版 | 2008 | ハウツー・レベルの本ではなく、認知科学ほかの成果に基づいて文書表現についての学術レベルの議論を行っている |
木下 是雄 | 理科系の作文技術 | 中央公論新社 | 1981 | 古くから多くの技術者や研究者に読まれている論文や技術文書作成のバイブル |
木下 是雄 | レポートの組み立て方 | 中央公論新社 | 1981 | |
木暮 太一 | 学校で教えてくれない「分かりやすい説明」のルール | 光文社 | 2011 | |
木暮 太一 | 誰にでも伝わる文章力のつくり方 | あさ出版 | 2012 | |
後藤 禎典 | 上手な文章を書きたい! | 光文社 | 2004 | |
小笠原 信之 | 伝わる!文章力が身につく本 | 高橋書店 | 2011 | |
小野田 博一 | 論理的に書く方法 | 日本実業出版社 | 1997 | |
小山 透 | 科学技術系のライティング技法 | 慶応義塾大学出版会 | 2011 | |
齋藤 孝 | 実践日本語ドリル | 宝島社 | 2003 | |
佐藤 健 | SEのための「構造化」文書作成の技術 | 技術評論社 | 2008 | |
佐渡島,吉野 | これから研究を書く人のためのガイドブック | ひつじ書房 | 2008 | |
篠田 義明 | ビジネス文完全マスター術 | 角川書店 | 2003 | 印象に残っている一部だけ紹介。 [概要] ・一文一概念 - 一つの句読点の中には、一つの内容しか書いてはいけない。 - 接続詞をたくさん使ってダラタラ書いても読み手に伝わらない。 ・段落(パラグラフ)構成法 文章構成技術を紹介(下記3つの方法を覚えれば大抵の文書が書ける) - 並列型 - 直列型 - 並直混載型 [補足] 若手社員の文書作成教育に使用させてもらっています |
清水 久三子 | プロの資料作成力 | 東洋経済新報社 | 2013 | |
清水 久三子 | ロジカル・ライティング | 日経文庫 | 2013 | 第4章まで共通的な基本が述べられており、残りの4章で、共有文書(議事録、告知文書)、報告文書、依頼文書、説得文書の書き方が各論として説明されています |
下村 耕平 | これからの技術文書-国際化時代の技術者・翻訳者必携、競争に勝つドキュメンテーションの論理と方法論 | アルカ | 1987 | 次の技術文書の7要件が記載 [1]因果関係が明確であること.[2]事実と意見が明確に区別されていること. [3]何について述べるか「識別」と,どこまでのべるか「限定」が明確になっていること.[4]論理構造が明確であること.[5]論理的な抜けがないこと.[6]具体的に記述されていること.[7]短文であること |
園部 俊晴 | 医療従事者のための「効果的な文章の書き方」入門 | 運動と医学の出版社 | 2010 | |
高杉 尚孝 | 論理表現力 | 日本経済新聞出版社 | 2010 | |
高橋 昭男 | ザ・テクニカルライティング | 共立出版 | 1993 | |
塚本真也 | 知的な科学・技術文章の徹底演習 | コロナ社 | 2007 | |
テクニカルコミュニケーター協会 | 日本語スタイルガイド | テクニカルコミュニケーター協会出版事業部会 | 2009 | テクニカルライティングの基本を押さえるためのガイドブック 2013.1に第2版が発売された |
戸田山 和久 | 論文の教室 レポートから卒論まで | 日本放送出版協会 | 2002 | |
富永 敦子, 細井 雅康 | わかりやすく説明する技術 | 実業之日本社 | 2005 | |
長尾 真 | 機械翻訳文の質の評価と言語の制限 | 情報処理学会(情報処理,Vol.26,No.1 pp.1197-1202,Oct.) | 1985 | to download the pdf |
中島 利勝, 塚本 真也 | 知的な科学・技術文章の書き方 - 実験リポート作成から学術論文構築まで - | コロナ社 | 1996 | |
中村 光伴 | 文章評価へのLatent Se,amtoc Analysis(LSA)の適用可能性 | 日本教育心理学会(日本教育心理学会総会発表論文集) | 2003 | |
成川 豊彦 | 成川式文章の書き方 | PHP研究所 | 2003 | |
成田 秀夫 | 学びと仕事をつなぐ8つの日本語スキル | 丸善プラネット | 2012 | |
二通 信子, 佐藤 勢紀子, 因 京子, 山本 富美子, 大島 弥生 | 留学生と日本人学生のためのレポート・論文表現ハンドブック | 東京大学出版会 | 2009 | 様々な分野の論文の形式や傾向を整理した調査結果あり |
日本エディタスクール | 日本語表記ルールブック | 日本エディタスクール | 2005 | |
日本心理学会 | 執筆・投稿の手引き | 日本心理学会 | 1995 | |
日本翻訳連盟 標準スタイルガイド検討委員会 | JTF日本語標準スタイルガイド 第2.0版 | 日本翻訳連盟 | 2012 | 実務翻訳業界での外国語から日本語に翻訳する際の日本語表記ガイドライン 最新版はJTF日本語標準スタイルガイド 第2.0版(2014.2) |
バーバラ・ミント | 考える技術・書く技術 | ダイヤモンド社 | 1999 | |
福田 修 他 | SEを極める 仕事に役立つ文章作成技術 | 日経BP社 | 2005 | |
藤沢 晃治 | 「分かりやすい文章」の技術 | 講談社 | 2004 | |
森岡 健二 | 文書構成法 | 東海大学出版会 | 1995 | |
三島 浩 | 技術者・学生のためのテクニカルライティング | 共立出版 | 1990 | |
Gretchen Carey, Michelle Hernandez, Ann Kilty Hughes, Polly Longo, Deirdre Rouiller, Shannon Wilde, Elizabeth Hargis | Developing Quality Technical Information: A Handbook for Writers and Editors | IBM Press | 2004 | |
U.S. Securities and Exchange Commission | A Plain English Handbook: How to Create Clear SEC Disclosure Documents | U.S. SEC | 1998 | http://www.sec.gov/pdf/handbook.pdf |
Plain Language Action and Information Network (PLAIN) | Federal Plain Language Guidelines | PLAIN | 2011 | to download the pdf |
ツール名 (リンク先は予備調査結果,WGメンバ参照可) | 開発者/販売元 | リリース年 | 製品URL |
Just Right! 4 | ジャストシステム | 2004 (最新版はJust Right! 5) | 製品ページ⇒http://www.justsystems.com/ jp/products/justright/ |
日本語スタイルガイド第3版対応ATOK・Just Right! データ集 | TC協会・ジャストシステム | 2016 | https://www.jtca.org/standardization/index.html#23 |
#freeze
以下の方針の下、ASDoQ会員は、用語集wikiを編集できます。
※ASDoQ標準用語
以下の方針の下、ASDoQ会員は、用語集wikiを編集できます。
「システム開発文書品質」を研究する上で、共有すべき定義、用語の扱い方に対する方針を提示します。
「システム開発文書品質」を ‘「システム開発文書」の「文書品質」’ ととらえます。
(注)「システム開発」の「文書品質」でも、「システム開発文書」の「品質」でもありません。
このとらえ方の下で、「システム開発文書品質」という複合語に対して、「システム開発文書」「文書品質」「システム開発」の用語間の構成関係を下図に示しました。
そして、「システム開発文書品質」を含む4用語に関して、ASDoQの活動において標準的に使用する用語としての定義を示します。
「システム開発文書品質」に関連する用語の中で、重要であると思われるものをリストアップし、調査と整理を行う。その上で、ASDoQとしての見解を説明します(ASDoQ標準用語を含む)。
主に、他の辞書や資料での用語の定義を調べ、用語定義部会にて参照すべきと判断した定義の表現を掲載しています。
中には、用語としての使用を想定した議論が進んでいるものも含んでいます。
ASDoQの定義以外に参考となる他の文献からの定義を載せています。
各略語・記号は次のとおりです。
⇒用語集に戻る
(IEEE Std 830-1998 4.3 Characteristics of a good SRS)
(IEEE Std 830-1998 4.3 Characteristics of a good SRS)
(日本語訳は、月刊「ビジネスコミュニケーション」((株)ビジネスコミュニケーション社)の「要求工学」第3回「要求仕様」による)
( IEEE Std 830-1998 4.3 Characteristics of a good SRS)
(日本語訳は、月刊「ビジネスコミュニケーション」((株)ビジネスコミュニケーション社)の「要求工学」第3回「要求仕様」による)
(IEEE Std 830-1998 4.3 Characteristics of a good SRS)
(日本語訳は、月刊「ビジネスコミュニケーション」((株)ビジネスコミュニケーション社)の「要求工学」第3回「要求仕様」による)
No. | タイトル (リンク先は予備調査結果) | 著者 | 出版社 | 出版年 | 概要または特記事項 |
No. | タイトル (リンク先は予備調査結果) | 著者 | 出版社 | 出版年 | 概要または特記事項 |
書籍
(a1)技術文書全般の技術
(a2)システム開発文書に関わる技術
標準・基準・規約
(b1)開発プロセス
(b2)プロジェクト管理
(b3)レビュー
ツール
論文
No. | タイトル (リンク先は予備調査結果) | 著者 | 出版社 | 出版年 | 備考 |
a1-1 | 理科系の作文技術 | 木下 是雄 | 中央公論新社 | 1981 | |
a1-2 | レポートの組み立て方 | 木下 是雄 | ちくま学芸文庫 ちくまライブラリー | 1994 1990 | |
a1-3 | 日本語スタイルガイド | テクニカルコミュニケーター協会 | テクニカルコミュニケーター協会出版事業部会 | 2009 | |
a1-4 | 考える技術・書く技術 | バーバラ・ミント | ダイヤモンド社 | 1999 | |
a1-5 | SEを極める 仕事に役立つ文章作成技術 | 福田 修 他 | 日経BP社 | 2005 | |
a1-6 | 論理表現力 | 高杉尚孝 | 日本経済新聞出版社 | 2010 | |
a1-7 | 執筆・投稿の手引き | 日本心理学会 | 日本心理学会 | 1995 | |
a1-8 | APA Publication Manual(APA論文作成マニュアル) | APA(アメリカ心理学会) 訳:江藤 他 | American Psychological Association | 2001 | |
a1-9 | SEのための「構造化」文書作成の技術 | 佐藤健 | 技術評論社 | 2008 | |
a1-10 | 文書構成法 | 森岡健二 | 東海大学出版会 | 1995 | |
a1-11 | 伝達力の基本 | 大石哲之 | 日本実業出版社 | 2011 | |
a1-12 | 明文術 | 阿部圭一 | NTT出版 | 2006 | |
a1-13 | これからの技術文書-国際化時代の技術者・翻訳者必携、競争に勝つドキュメンテーションの論理と方法論 | 下村耕 | アルカ | 1987 | 技術文書の7要件が記載 |
No. | タイトル (リンク先は予備調査結果) | 著者 | 出版社 | 出版年 | 備考 |
a2-1 | ソフトウェアドキュメンテーション | 塩谷敦子 他 | デンソークリエイト | 1999 | |
a2-2 | ~要求を可視化するための~要求定義・要求仕様書の作り方 | 山本修一郎 | ソフト・リサーチ・センター | 2006 | |
a2-3 | Requirements Engineering | Elizabeth, H.,Jackson, Dick, J. | Springer | 2002 | P.83, 4.8 に,要求文記述の構文テンプレートあり.P89,4.11 に,要求文書の評価基準の例あり |
a2-4 | 要求仕様定義ガイドライン(UVC研究プロジェクト報告書) | (社)日本情報システム・ユーザー協会 編 | (社)日本情報システム・ユーザー協会(JUAS) | 2007 | |
a2-5 | 要求工学 | 大西淳 | 共立出版 | 2002 | http://www.kyoritsu-pub.co.jp/shinkan/shin0205_04.html |
a2-6 | ソフトウェア要求 | Karl.E.Wiegers | 日経BPソフトプレス | 2001 | |
a2-7 | ソフトウェアの仕様化と設計 | 編集責任 花田收悦 | 日科技連出版社 | 1986 | 日科技連ソフトウェア品質管理シリーズ 第2巻 「第2章ドキュメンテーション」 |
a2-8 | 外国人プログラマ向け設計書の留意点 | 幸地司 | 2008 | http://gihyo.jp/magazine/emind/archive/2008/vol9 |
書籍
(a1)技術文書全般の技術
(a2)システム開発文書に関わる技術
標準・基準・規約
(b1)開発プロセス
(b2)プロジェクト管理
(b3)レビュー
ツール
論文
No. | タイトル (リンク先は予備調査結果) | 著者 | 出版社 | 出版年 | 概要または特記事項 |
a1-1 | 理科系の作文技術 | 木下 是雄 | 中央公論新社 | 1981 | |
a1-2 | レポートの組み立て方 | 木下 是雄 | ちくま学芸文庫 ちくまライブラリー | 1994 1990 | |
a1-3 | 日本語スタイルガイド | テクニカルコミュニケーター協会 | テクニカルコミュニケーター協会出版事業部会 | 2009 | |
a1-4 | 考える技術・書く技術 | バーバラ・ミント | ダイヤモンド社 | 1999 | |
a1-5 | SEを極める 仕事に役立つ文章作成技術 | 福田 修 他 | 日経BP社 | 2005 | |
a1-6 | 論理表現力 | 高杉尚孝 | 日本経済新聞出版社 | 2010 | |
a1-7 | 執筆・投稿の手引き | 日本心理学会 | 日本心理学会 | 1995 | |
a1-8 | APA Publication Manual(APA論文作成マニュアル) | APA(アメリカ心理学会) 訳:江藤 他 | American Psychological Association | 2001 | |
a1-9 | SEのための「構造化」文書作成の技術 | 佐藤健 | 技術評論社 | 2008 | |
a1-10 | 文書構成法 | 森岡健二 | 東海大学出版会 | 1995 | |
a1-11 | 伝達力の基本 | 大石哲之 | 日本実業出版社 | 2011 | |
a1-12 | 明文術 | 阿部圭一 | NTT出版 | 2006 | |
a1-13 | これからの技術文書-国際化時代の技術者・翻訳者必携、競争に勝つドキュメンテーションの論理と方法論 | 下村耕 | アルカ | 1987 | 技術文書の7要件が記載 |
No. | タイトル (リンク先は予備調査結果) | 著者 | 出版社 | 出版年 | 概要または特記事項 |
a2-1 | ソフトウェアドキュメンテーション | 塩谷敦子 他 | デンソークリエイト | 1999 | |
a2-2 | ~要求を可視化するための~要求定義・要求仕様書の作り方 | 山本修一郎 | ソフト・リサーチ・センター | 2006 | |
a2-3 | Requirements Engineering | Elizabeth, H.,Jackson, Dick, J. | Springer | 2002 | P.83, 4.8 に,要求文記述の構文テンプレートあり.P89,4.11 に,要求文書の評価基準の例あり |
a2-4 | 要求仕様定義ガイドライン(UVC研究プロジェクト報告書) | (社)日本情報システム・ユーザー協会 編 | (社)日本情報システム・ユーザー協会(JUAS) | 2007 | |
a2-5 | 要求工学 | 大西淳 | 共立出版 | 2002 | http://www.kyoritsu-pub.co.jp/shinkan/shin0205_04.html |
a2-6 | ソフトウェア要求 | Karl.E.Wiegers | 日経BPソフトプレス | 2001 | |
a2-7 | ソフトウェアの仕様化と設計 | 編集責任 花田收悦 | 日科技連出版社 | 1986 | 日科技連ソフトウェア品質管理シリーズ 第2巻 「第2章ドキュメンテーション」 |
a2-8 | 外国人プログラマ向け設計書の留意点 | 幸地司 | 2008 | http://gihyo.jp/magazine/emind/archive/2008/vol9 |
番号,略称など | 発表年 | 名称 | 備考 |
IEEE 830 | 1998 | IEEE Recommended Practice for Software Requirements Specifications | 次の記載あり ・要求仕様の構成 ・要求仕様が満たすべき性質 |
IEEE 1233 | 1996 | IEEE Guide for Developing System Requirements Specifications |
番号,略称など | 発表年 | 名称 | 備考 |
IEEE 1016 | 2009 | IEEE Standard for Information Technology-Systems Design- Software Design Descriptions |
番号,略称など | 発表年 | 名称 | 備考 |
IEEE 1061 | 1998 | IEEE Standard for a Software Quality Metrics Methodology | |
ISO-IEC 9126 | 1991 | Information technology software product evaluation:Quality characteristics and guidlines for their use | JIS X 0129 ソフトウェア製品の評価-品質特性及びその利用要領 (X 0129-1 http://www.jisc.go.jp/ app/pager?id=7523) |
ツール名 (リンク先は予備調査結果) | 開発者/販売元 | リリース年 | 製品URL |
Just Right! 4 | ジャストシステム | 2004 (最新版JustRight!4は2009) | http://www.justsystems.com/ jp/products/justright/ |
著者 | 表題 | 雑誌名 | 発表年 | 巻数(号数)・所在ページ |
テクニカルコミュニケーションにおける日本語スタイルガイドと表現手法の変化 | 雨宮 拓 | 情報処理学会研究報告,DD | 2010 | 2010-DD-77(1), 1-3 |
文章評価へのLatent Se,amtoc Analysis(LSA)の適用可能性 | 中村光伴 | 日本教育心理学会総会発表論文集 | 2003 | |
組込みソフトウェア開発文書診断法 | 藤田 悠 他 | 情報処理学会研究報告,UB | 2010 | 25,1 |
テキスト分析技術を用いた開発関連文書の品質分析 | 竹内広宜 | 組込みシステムシンポジウム | 2009 | |
キーワードベースドレビュー | 河野 哲也 | ソフトウェアテストシンポジウム | 2010 |
すべてのページが誰でも編集できます。変更したいページでページ上部の「編集」をクリックするとそのページが編集できます。編集内容は、整形ルールに従って整形されます。
練習用ページは基本的にどのように手を加えても問題ないので、結果を恐れず編集してみてください。
すでにあるページ(例えば練習用ページなど)で、ページのどこかにWikiName(大文字と小文字混合)かBracketName([[]]で囲う)を入力すると入力した部分の後ろに ? というリンクがつきます。そこをクリックすると新しいページの編集画面が用意されるので、あとは普通のページ変更と同様に書き込むことができます。
Wikiとはそういうものです。誰でもどこでも書き加えたり、直したりできます。PukiWikiには定期的にバックアップを取る機能がありますので、バックアップから復旧させることもできます。
ページを編集する以上、編集時の状態から手を加える形になります。しかし、もし編集中に誰かが更新していてしまっていたらどうします? 安心してください。PukiWikiには、更新時のページの更新日時と元データの更新日時を比較して一緒かどうかチェックします。「更新の衝突」が起きた場合はそのページをリロードし、編集し直してください。
WikiNameの書式で表現できない日本語などをページ名として扱えるようにする書式。
[[BracketName]]
のように [[ ]] で囲うとBracketNameになります。 もちろん日本語もOK。
]]>通常は入力した文章がそのまま出力されます。
これに加えて、特定のルールによるテキスト整形を行うことができます。以下では、プラグインについてはよく使われるものだけを簡略に説明しています。プラグインのオプションなど詳細な説明については PukiWiki/1.4/Manual/Plugin を参照してください。
インライン要素
他のブロック要素を明示しない限り、段落となります。
~ インライン要素
行頭で ~ を指定した場合も段落になります。行頭書式の文字(~、-、+、:、>、|、#、//)を通常の文字として段落の先頭に書きたい場合は、行頭に~を記述して書くことができます。
> インライン要素
行頭で > を指定すると、引用文になります。引用文は >、>>、>>> の3レベルあります。
- インライン要素
行頭で - を指定すると、番号なしリストになります。番号なしリストは -、--、--- の3レベルあります。
+ インライン要素
行頭で + を指定すると、番号付きリストになります。番号付きリストは +、++、+++ の3レベルあります。
: 定義語 | 説明文
行頭を : で始め、| 記号で区切ると、定義リストになります。定義リストは :、::、::: の3段階あります。定義リストの定義語、説明文は省略することができます。複数の連続した定義リストを記述し、2つ目以降の定義語を省略することで1つの定義語に対する複数の説明文を記述することができます。
行頭が半角空白で始まる行は整形済みテキストとなります。行の自動折り返しは行なわれません。
| インライン要素 | インライン要素 |
行頭から | でインライン要素を区切ることで表組みになります。
LEFT: CENTER: RIGHT: BGCOLOR(色): COLOR(色): SIZE(サイズ):
表組みの | 各セルの要素の配置に | 関するサンプル |
左寄せ | センタリング | 右寄せ |
右寄せ | 左寄せ | センタリング |
| ~Table with alignment |||h | right| center |left | |left | right| center | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | |=~Table with alignment |||h |>right |=center |<left | |<left |>right |=center | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Table with alignment | ||
---|---|---|
right | center | left |
left | right | center |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
LEFT: CENTER: RIGHT: BGCOLOR(色): COLOR(色): SIZE(サイズ):
,データ,データ,…
行頭でカンマ(,)を記述し、インライン要素をカンマ区切りで記述すると表組みになります。
* インライン要素
行頭で * を記述すると、見出しになります。見出しは *、**、*** の3段階あります。
#contents
行頭で #contents を記述すると、見出しに基づいて目次を作成します。一般的に #contents はページの最初のほうに記述します。
LEFT:インライン要素 CENTER:インライン要素 RIGHT:インライン要素
行頭で LEFT:、 CENTER:、 RIGHT: を記述すると、インライン要素が左寄せ、センタリング、右寄せされます。
---------------------------------------------
行頭で4つ以上の - を書くと水平線になります。
#hr
行頭で #hr を記述すると、区切り線になります。区切り線は上位のブロック要素の幅の60%の長さの水平線がセンタリングされて引かれます。
#br
行頭で #br を記述すると、ブロック要素間またはブロック要素内で行間を開けることができます*2。
#ref(添付ファイル名) #ref(ファイルのURL)
行頭で #ref を記述すると、添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。
添付ファイルのページ
left center right
wrap nowrap
around
nolink
代替文字列
#clear
行頭で #clear を記述すると、 #ref で指定したテキストの回り込みを解除します。 #clear を指定しなくても、記事の末尾でテキストの回り込みが自動的に解除されます。
#comment
行頭で #comment を記述すると、コメントを挿入するためのフォームが埋め込まれます。
#pcomment
行頭で #pcomment を記述すると、コメントを挿入するためのフォームが埋め込まれます。 #comment とは異なり、コメントは別ページに記録されます。また、コメントに対するレスポンスを階層状に表示します。
#article
行頭で#articleを記述すると、簡易掲示板のフォームが埋め込まれます。
#vote(選択肢1,選択肢2,...)
行頭で #vote を記述すると、簡易投票フォームが埋め込まれます。
インライン要素~
行末に~を書くと行末改行になります。行末改行はブロック要素内での改行になります。
&br;
行中に &br; を書くと、そこで改行されます。行末の ~ と違い、定義リストの定義語や表組の要素、# で始まるブロック要素のパラメタの中でも使用できます。
''インライン要素''
行中のインライン要素を '' ではさむと、インライン要素が 強調表示 になります。
'''インライン要素'''
行中のインライン要素を ''' ではさむと、インライン要素が 斜体表示 になります。
&size(サイズ){インライン要素};
行中に &size を書くとインライン要素の文字サイズを指定することができます。サイズはピクセル単位(px)で指定します。例えば20を指定すると、20ピクセルの文字の大きさになります。
&color(文字色,背景色){インライン要素};
行中に &color と書くとインライン要素の文字色と背景色を指定することができます。背景色は省略できます。
%%インライン要素%%
行中のインライン要素を%%ではさむと、インライン要素に取消線が付きます。
((インライン要素))
行中でインライン要素を (( と )) ではさむと、注釈*3が作成され、行中に注釈へのリンクが貼られます。
&ref(添付ファイル名[,パラメタ]){代替文字列}; {{添付ファイル名[,パラメタ]|代替文字列}} &ref(ファイルのURL[,パラメタ]){代替文字列}; {{ファイルのURL[,パラメタ]|代替文字列}}
行中で &ref または、{{ }} を記述すると、添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。
添付ファイルのページ
nolink
代替文字列
&ruby(ルビ){インライン要素};
行中で &ruby を書くとインライン要素に対するルビをふることができます。ルビに対応していないブラウザではルビが本文中に ( と ) に囲まれて表示されます。
&aname(アンカー名); &aname(アンカー名){インライン要素};
行中で &aname を記述するとリンクのアンカーを設定することができます。リンクの飛び先にしたい位置に記述します。
&counter; &counter(オプション);
行中で &counter を記述するとそのページにアクセスした人の数を表示することができます。
today
yesterday
total
&online;
行中で &online を記述すると現在アクセス中の人数を表示することができます。
&version;
行中で &version を記述するとPukiWikiのバージョンを表示することができます。
WikiName
行中で、1つ以上の大文字→1つ以上の小文字→1つ以上の大文字→1つ以上の小文字の組合わせからなる半角//文字列はWikiNameになります。
[[ぷきうぃき]]
行中で [[ と ]] で囲まれた文字列はページ名になります。
[[ページ名#アンカー名]]
[[InterWikiName:ページ名]]
行中のページ名形式の文字列の中で、: で2つの文字列を区切るとInterWikiになります。:の前にはInterWikiNameのページで定義したInterWikiNameを、: の後ろにはページ名を記述します。
[[InterWikiName:ページ名#アンカー名]]
[[リンク名:URL]]
行中のInterWikiNameの形式の文字列の中で、: の前に任意のリンク名を、: の後ろにURLを記述すると、そのリンク名でURLに対するリンクを貼ることができます。
http://www.example.com/ https://www.example.com/ ftp://ftp.example.com/ news://news.example.com/ foo@example.com
[[エイリアス名>ページ名]]
行中のページ名形式の文字列の中で、> で2つの文字列を区切るとエイリアスになります。 > の前にはエイリアス名を、> の後ろにはページ名を記述します。
エイリアスはPukiWiki内のページ名とは別のエイリアス名で、指定したページへのリンクを貼ります。
[[エイリアス名>ページ名#アンカー名]] [[エイリアス名>#アンカー名]]
[[エイリアス名>http://www.example.com/]] [[エイリアス名>https://www.example.com/]] [[エイリアス名>ftp://ftp.example.com/]] [[エイリアス名>news://news.example.com/]] [[エイリアス名>foo@example.com]] [[エイリアス名>InterWikiName:ページ名]] [[エイリアス名>InterWikiName:ページ名#アンカー名]]
[[エイリアス名:http://www.example.com/]] [[エイリアス名:https://www.example.com/]] [[エイリアス名:ftp://ftp.example.com/]] [[エイリアス名:news://news.example.com/]] [[エイリアス名:foo@example.com]]
&t;
行中で &t; と書くと、タブコードに置換されます。
通常、フォーム内ではキーボードからタブコードを直接入力できない*4ので、タブコードを入力したい位置に&t;を記述すると、保存時にタブコードに置換します。
&page; &fpage;
行中で &page; 及び &fpage; と書くと、編集中のページ名に置換されます。ページ名が階層化されたページで「hogehoge/hoge」となっている場合、 &page; は「hoge」に、 &fpage; は「hogehoge/hoge」に置換されます。階層化されていないページでは、 &page; も &fpage; も同じになります。
&date; &time; &now;
date? time? now?
&_date; &_time; &_now;
&lastmod; &lastmod(ページ名);
文字参照は、SGMLで定義されている文字参照文字(©や®など)のほか、下記の独自の文字参照文字が使用できます。
&heart; ⌣ &bigsmile; &huh; &oh; &wink; &sad; &worried;

進数; 進数;
行中で &# と ; の間に10進数を、&#x と ;の間に16進数を書くと、Unicodeを数値参照して表示します。キーボードから直接入力できない文字やJIS第3水準・第4水準の文字などの表示に使用します。たとえば、内田百閒と入力すると、内田百閒と表示されます。
このページは、ページを指定しない時に表示されます。
あなたのサイトに合わせ、自由に編集してください *1
InterWiki用のサーバリストです。
[URL サーバ名] タイプ
の形式で記述してください。