文書品質改善.ppt

ソフトウェア 関 連 文 書 の 品 質 改 善 小 川 清, 斉 藤 直 希 名 古 屋 市 工 業 研 究 所 (ogawa.kiyoshi,saito.naoki)@nmiri.city.nagoya.jp

目 次! 1. 背 景! 2. 先 行 研 究! 3. 関 連 研 究! 4. 事 例 研 究! まとめ

1. 背 景! ソフトウェア 単 体 品 質 測 定 とシステムにおける 品 質 測 定! 利 用 時 の 品 質 (quality in use)! ソフトウェアと 文 書 の 管 理 が 煩 雑! 追 跡 したいのはソフトウェア 文 書 よりも 開 発 者 そのもの! 正 しい 文 書 は 役 に 立 たないかも! 美 しい 文 書 が 役 に 立 つかも! 情 報 処 理 学 会 夏 のプログラミングシンポジウム2012 beautiful code! SWEST 徹 夜 部 屋 での 議 論! ソフトウェア 設 計 文 書 に 図 が 少 ない! HAZOPなどで 分 析 するには 設 計 図 が 好 ましい! 書 籍 の 作 成, 印 刷 業 界 向 けLaTeX 研 修 などの 実 施

TOPPERSプロジェクトは 敷 居 が 高 い! OSC Nagoya 2012, OSC Hokkaido 2012に 最 小 セットカー ネル で 出 展,OSC Sendai 2012に 参 加! 日 本 技 術 士 会 のHAZOPのセミナを 受 講 いただいた 方 で ET 2011で 名 古 屋 市 工 業 研 究 所 のブースを 訪 問 してくだ さった 方! CESTの 会 員 から! SWESTの 部 屋 で! 文 書 とソフトウェアの 品 質 : 可 読 性, 満 足 性 を 高 めることに より オープンソースの 敷 居 を 低 くする

研 究 の 目 的! 利 害 関 係 者 の 効 率 的 な 合 意 形 成! システムとソフトウェアの 継 ぎ 目 のない 設 計, 試 験! 文 書 作 成 の 知 見 (best practice)を 集 める! 知 見 をソフトウェア 品 質 に 基 づき 輪 郭 (profile)に 分 類 する! 輪 郭 に 品 質 目 標 と 現 状 を 記 載 し 改 善 する! ソース 公 開 事 業 の 文 書 (ソフトを 含 む) 体 系 の 効 率 的 な 維 持

2. 先 行 研 究! 日 本 語 情 報 処 理, 中 日 韓 越 情 報 処 理! システム 開 発 文 書 品 質 研 究 会 - ASDoQ あいまい な 日 本 語 表 現 考 阿 部 圭 一 ( 愛 工 大 )! 美 しい 日 本 の 私,あいまいな 日 本 の 私! 正 確 な 文 章 の 書 き 方

日 本 語 情 報 処 理, 中 日 韓 越 情 報 処 理 文 字 コード 文 字 フォント 検 索, 編 集 ( 前 向 き, 後 ろ 向 き)

美 しい 日 本 の 私, あいまいな 日 本 の 私

ソフトウェア 品 質 特 性

品 質 作 り 込 みガイド! 輪 郭 (profile)! 複 数 の 単 位 の 異 な る 品 質 目 標 に 対 す る 現 在 の 状 況

正 確 な 文 章 の 書 き 1. 伝 えたいこと/あふれる 思 い( 内 容 ) 2. 正 確 さ/ 曖 昧 さの 排 除 ( 正 確 ) 3. 豊 かさ/ 軽 やかさ( 豊 富 ) 4. バランス 感 覚 / 素 直 さ( 均 衡 ) 5. 内 容 の 構 成 ( 構 成 ) 6. 思 いきり/ 吟 味 する( 吟 味 )

3. 関 連 研 究! 作 成 書 籍 類! データベース 検 索 技 術 者 認 定 試 験 傾 向 と 対 策, 紀 伊 國 屋 書 店! Microsoft Exchange 活 用 ガイド, 技 術 評 論 社! 組 込 み 開 発 事 例 集, 工 業 調 査 会! MISRA-C, 日 本 規 格 協 会! プロセス 改 善 ナビゲーションガイド ベストプラクティス 編, オーム 社! 機 械 翻 訳! 視 点 と 条 件! 情 報 検 索! 用 語 の 木

データベース 検 索 技 術 者 認 定 試 験 傾 向 と 対 策 紀 伊 國 屋 書 店! 絶 版 なのでウェブに 画 像 がありませんでした ごめんなさい! すべてLaTeX 入 稿! 著 者 MS-ODS, 出 版 社 Linux! 文 字 コード! 処 理 ソフトウェアの 違 い! 索 引 の 整 理 が 大 変! 分 野 の 用 語 が

Microsoft Exchange 活 用 ガイド 技 術 評 論 社! Windows 95にTCP/IP, Exchange mailが 同 梱 している のにマニュアルがない! 当 初 作 成 した 内 容 の3 分 の1を 編 集 者 の 判 断 で 削 除! 一 部 の 人 間 にしか 必 要 のない 資 料! MS Wordで 作 成! 当 初 販 売 数 が 伸 びなかったが 平 積 み 書 店 を 増 やし たら 売 れ 始 めた

組 込 み 開 発 事 例 集! 産 業 技 術 連 絡 会 議! 産 業 総 合 研 究 所 と 都 道 府 県 公 的 試 験 研 究 機 関! 共 同 研 究 企 業 紹 介! 名 古 屋 の 事 例! 大 江 無 線 ( 株 ): 放 送 機 器! ( 株 )トラフィックシム: 放 送 機 器! アイチシステム( ): 通 信 装 置! ( 株 )ヴィッツ: 自 動 車 向 けOS

MISRA-C

プロセス 改 善 ナビゲーション ガイド ベストプラクティス 編 IPA/SEC

機 械 翻 訳! 英 文 特 許 文 書 を 日 本 語 に 翻 訳! 複 文 を 単 文 に 分 割 する! 権 利 関 係 を 保 持 してい る! 言 葉 を 補 う! 1つの 単 語 は 一 つの 意 味! 発 話 者 と 聞 き 手 ( 読 み 手 ) との 関 係 で 意 味 を 特 定 す る

視 点 と 条 件! 視 点 1:プログラマ A:ソフトウェア,B: 文 書 全 体 集 合 :ソフトウェア! 視 点 2: 文 筆 業,A:ソフトウェア,B: 文 書 全 体 集 合 : 文 書! 条 件 : 視 点 1/2のどちらでも 成 り 立 つ or どちらかの 視 点 のみで 成 り 立 つ

情 報 検 索! データベース 検 索 技 術 者 認 定 試 験 傾 向 と 対 策, 紀 伊 國 屋 書 店! 異 分 野 の 辞 書 を 接 合 しているため 用 語 体 系 が 継 ぎ 接 ぎ! 商 用 の 用 語 と 学 術 用 語 の 混 同! (Like 函 数 型 言 語 を 使 ってはいけない )! JIS 用 語 定 義 を 付 録

用 語 の 木! 処 理 (process)! NT 活 動 (activity)! NT 仕 事 (task)! NT 自 動 処 理 (automation)! RT 入 力 (input)! RT 出 力 (output)! RT 手 順 (procedure)! NT: 下 位 語 (Narrower term)! RT: 関 連 後 (related term)

4. 事 例 研 究 4.1 責 任 校 正 4.2 LaTeX 4.3 プログラミング 教 育 4.4 ソフトウェア 導 入 4.5 読 書 記 録 4.6 技 術 文 書 の 評 価

4.1 責 任 校 正 1. 句 読 点 の 抜 け, 重 複 (F.2 正 確 性 ) 2. 横 向 き, 逆 さま(F.2 正 確 性 ) 3. 字 下 げ(F.2 正 確 性 -> 理 解 性 ) 4. 番 号 (F.2 正 確 性 + 理 解 性 ) 5. てにをは,ですます(U.1 理 解 性 + 正 確 性 ) 6. 固 有 名 詞 の 綴 り,スペル(U.1 理 解 性 )

4.2 LaTeX

文 書 作 成 指 針 (LaTeX 研 修 ) 1. 文 字 の 大 きさは5 種 類 ( 論 理 階 層 が5 階 層 くらい)(U.1 理 解 性 ) 2. 文 字 の 種 類 (font) は,アルファベット, 日 本 語 でそれぞれ3 種 類 (U.1 理 解 性 ) 3. 略 号 にはフルスペルをつける(U.1 理 解 性 ) 4. 赤 は 危 険 または 注 意 喚 起 のみにする ( 会 社 のロゴなどに 赤 を 使 っている 場 合 は 注 意 喚 起 の 一 種 と 看 做 す )(U.1 理 解 性 ) 5. 意 味 の 塊 ごとに 余 白 があり, 視 覚 的 に 意 味 の 違 いが 区 分 できる (U.1 理 解 性 ) 6. 要 点 は 箇 条 書 きにする (U.1 理 解 性 ) 7. 出 典 ( 参 考 文 献, URL)を 明 記 する (U.2 習 得 性 ) 8. 日 本 語 は 斜 体 を 用 いない( 斜 体 用 字 形 を 除 く)(U.4 魅 力 性 ) 9. LATEX 以 外 で 作 ったものをLATEX にしてみて, 段 組 みの 違 いから,より 美 しい 状 態 を 理 解 して,どちらの 道 具 でもより 美 しく 作 る (U.4 魅 力 性 )

4.3 プログラミング 教 育 1. 文 法 誤 り(F.2 正 確 性 ) 2. 処 理 不 能 文 字 (F.2 正 確 性 ) 3. 範 囲 外 (F.1 合 目 的 性 ) 4. 意 味 の 間 違 い(F.1 合 目 的 性 ) 5. 未 定 義 の 変 数 (U.1 理 解 性 )

4.4 ソフトウェア 導 入 SML#の 導 入 にあたって 1. 導 入 の 制 約 条 件, 導 入 手 順 の 明 確 化 (F.1 合 目 的 性 )! 新 しい 版, 利 用 者 の 少 ない 機 材 の 対 応 の 手 が 足 りない 2. 導 入 ソフトウェアの 構 成 管 理 (M.1 解 析 性 )! AppleStoreによるXcode 配 布,TOOLのDeveloper 配 布 3. 被 導 入 システムの 構 成 管 理 (M.1 解 析 性 )! MacPortsの 利 用 4. 他 のソフトウェアとの 比 較 (U.1 理 解 性 )! Ocaml, scara, F#, Haskel 5. 他 のソフトウェアとのデータ 交 換 (P.4 置 換 性 )! Coqからの 生 成 (proofcafe)

4.5 読 書 記 録! 機 能 安 全 プロジェクトの 能 力 判 定 の 根 拠 (3 年 で1 万 冊 目 標 )! 要 員 による 確 認 (3 千 冊 まで), 能 力 (skill) 判 定 に 利 用! リスト 利 用

改 善 方 法 例 1. 否 定 文 は 肯 定 文 に: ふりがなが 少 ない ー> ふりがなが 少 しある 初 出 の 漢 字 にすべ て 振 ってもらえると 嬉 しい (U.4 魅 力 性 ) 2. 複 文 は 単 文 にして, 接 続 子 を 削 除 : 面 白 いが, 複 雑 すぎてわかりにくい ー> 面 白 い 複 雑 で 分 かりにくいところが 一 部 ある (M.1 解 析 性 ) 3. 思 い 込 みの 形 容 詞, 助 詞, 接 続 子 などは 削 除 : 気 が 付 いたら 直 すだけで, 誤 字 を 探 す だけのために 読 まない ー> 気 が 付 いたら 直 す 文 章 の 入 れ 替 えのために 読 んで みるのを 主 眼 にする ( 理 解 性, 魅 力 性 ) 4. 誤 字 脱 字 の 訂 正 気 が 付 いたら 直 す 文 章 の 入 れ 替 えのために 読 んでみるのを 主 眼 に する ( 正 確 性 ) 5. 主 題 以 外 の 内 容 は 後 書 きp.s.) に( 合 目 的 性 ) 6. 主 観 記 述 から 事 実 記 述 へ( 理 解 性 ) 7. 自 分 の 興 味 の 順 から, 他 人 の 知 りたいかもしれない 順 に, 文 を 並 べ 替 える( 理 解 性 ) 8. カタカナ 語 を 漢 字 表 記,English 表 記 または 漢 字 (Chinese Character) 表 記 に( 理 解 性 )

定 量 化 手 法 (1) 技 術 文 書 用 に 優 先 順 位 変 更 6. 優 先 順 率 (U.1 理 解 性 )! 優 先 順 位 が 高 いものが 先 に 記 述 しているかの 割 合! 優 先 順 位 順 を1, 逆 順 を0として, 間 の 計 算 を 重 み 付 けして 求 め る 1. 単 文 率, 複 文 率 (M.1 解 析 性 ):! 単 文 率 + 複 文 率 = 1 3. 肯 定 率, 否 定 率 (U.4 魅 力 性 ):! 肯 定 率 + 否 定 率 = 1

定 量 化 手 法 (2) 8. 箇 条 書 き 率 (U.1 理 解 性 )! 文 章 の 中 の 箇 条 書 きの 割 合! 箇 条 書 きが9 割 を 超 えると, 文 章 というよりはデータと 看 做 す 場 合 もある 2. 形 容 度 (U.4 魅 力 性, M.1 解 析 性 ):! 名 詞 または 動 詞 に 形 容 詞 または 副 詞 などがついているか! 重 み 付 き 形 容 度! 2 重 に 形 容 している 場 合 は3 倍 または4 倍 などの 重 みをつける! 魅 力 性 はあげるが, 解 析 性 を 下 げる 場 合 がある 7. カタカナ 語 比 率 (U.1 理 解 性 )! 全 体 の 単 語 のうちのカタカナ 語 の 割 合 1 文 に1 つが 上 限 2 つ 以 上 入 れると 分 かりにくくなる

定 量 化 のまとめ! 一 つの 品 質 副 特 性 に 複 数 の 定 量 化 方 法 がある! 線 形 とは 限 らない! 対 象 文 書 により 定 量 化 手 法 の 優 先 順 位 は 変 わる! 目 標 値 を 設 定 して 改 善 を 図 る! 例 : 箇 条 書 き 率 3 割! LaTeXだとitemize, enumerate

4.6 技 術 文 書 の 評 価

輪 郭 (profile)の 作 成 5 まとめ 合 意 形 成, 目 標 設 定 のため 文 書 作 成 の 知 見 (best practice)の 収 集 ソフトウェア 品 質 特 性 への 分 類 文 書 目 的 に 合 わせた 測 定 方 法 測 定 手 法, 測 定 結 果 を 例 示 3つ 以 上 の 品 質 特 性 を 組 み 合 わせる 正 しい 文 書 が 価 値 があるとは 限 らない 矛 盾 がある 文 書 は 仕 立 て(tailoring)に 使 える ソース 公 開 ソフトはソフトと 文 書 を 一 括 評 価 可 能 であるためソフトウェア 品 質 副 特 性 が 有 効 課 題 自 動 生 成 に 応 用 文 書 からプログラム プログラムから 文 書 理 解 のための 機 能

! 文 書! 意 思 疎 通 の 手 段 理 解 のための 機 能! 人 間 対 人 間 : 自 然 言 語 ( 口 頭, 文 字 ), 表 情 / 身 ぶり, 図, 映 像, 音 楽,,,! 人 間 対 機 械 :HDL, アセンブラ,プログラミング 言 語,,,! 静 的 な 文 書 と 動 的 な 機 能 の 関 係! 分 かるための 文 書! 分 かるための 機 能! 試 験 一 式 (test suite)! 例! 証 明! 振 舞 表 示! 12011 年 TOPPERSアプリケーション 開 発 コンテスト! 中 村 晋 一 郎 Natural Tiny Shell http://sourceforge.jp/projects/ntshell/! TOPPERS 教 育 WG monitor task

参 考 文 献 [1] 日 本 語 情 報 処 理, Ken Lunde, ソフトバンククリエイティブ,1995 [2] 多 マルチリンガル 環 境 の 実 現 X Window/Wnn/Mule/WWW ブラウザでの 多 国 語 環 境, 錦 見 美 貴 子, 戸 村 哲, 桑 理 聖 二, 吉 田 智 子, 高 橋 直 人, 半 田 剣 一, 向 川 信 一, プレンティスホール 出 版,1996 [3] 日 本 語 語 彙 体 系, 岩 波 書 店, 池 原 悟, 宮 正 弘, 白 井 諭,1999 [4] 今 昔 文 字 鏡 Ver.1.0, エーアイネット,1997 [5] PAT-Transer, ノヴァ,1998 [6] WRAPL による 機 械 翻 訳 のためのテクスト 編 集 と 翻 訳 精 度 の 向 上, 佐 良 木 昌 加 藤 輝 政 小 川 清, 言 語 処 理 学 会 第 3 回 大 会,1997 [7] 英 語 複 文 の 構 文 解 析 と 編 集,その 論 理 と 方 法, 加 藤 輝 政 小 川 清 佐 良 木 昌, 電 子 情 報 通 信 学 会 信 学 技 報 Vol.97No.199 pp.65-70, 1997 [8] ISO/IEC 9126. Information technology Softwareproduct evaluation Quality characteristics and guidelinesor their use, 1991 [9] ISO/IEC 25000 Software Engineering Software productquality Requirements and Evaluation (SQuaRE) Guide to SQuaRE, 2005 [10] ソフトウェア 品 質 評 価 ガイドブック, 東 基 衛, 日 本 規 格 協 会,1994

! [11] 組 込 みソフトウェア 開 発 向 け 品 質 作 り 込 みガイド,IPA/SEC, 翔 泳 社,2008! [12] あいまいな 日 本 語 表 現 考, 阿 部 圭 一, ASDoQ, 2012! [13] あいまいな 日 本 の 私, 大 江 健 三 郎, 岩 波 書 店,1995! [14] 美 しい 日 本 の 私, 川 端 康 成, 講 談 社,1969! [15] 正 確 な 文 章 の 書 き 方, IIJ 技 術 研 究 所, 山 本 和 彦, 2009! [16] 分 かりやすく 伝 える 外 来 語 言 い 換 え 手 引 き, 国 立 国 語 研 究 所, 2006! [17] JIS 等 原 案 作 成 のための 手 引 き 第 12 版, 日 本 規 格 協 会, 2011! [18] ISO/IEC 専 門 業 務 用 指 針 (ISO/IEC Directives) 第 2 部 国 際 規 格 の 構 成 及 び 作 成 の 規 則 (Part 2 Rules forthe structure and drafting of International Standards),ISO/IEC, 2011! [19] JIS Z 8301 規 格 票 の 様 式 及 び 作 成 方 法, 日 本 規 格 協 会,2011! [20] コンピュータ 西 暦 2000 年 対 応 の 標 準 化 におけるデータ, 用 語, 処 理, 試 験, 小 林 武 史, 大 角 泰 久, 小 川 清, 言 語 処 理 学 会 年 次 大 会 2000! [21] 日 本 語 はどういう 言 語 か, 三 浦 つとむ, 1956! [22] 佐 良 木 昌 編, 言 語 過 程 説 の 探 求 第 一 巻, 明 石 書 店,2004

! [23] 認 知 文 法 論, 山 梨 正 明, ひつじ 書 房,1995! [24] リアルタイム 組 み 込 みソフトウェアの 用 語 の 木, 小 川 清, 斉 藤 直 希, 吉 川 直 邦, 伊 藤 正 樹, 後 田 直 樹, 藩 建 華, 情 報 処 理 学 会 研 究 報 告. SLDM, 2003! [25] ソフトウェアプロセスアセスメントの 用 語 構 造 と 診 断, 小 川 清, 言 語 認 識 表 現 研 究 会,1999! [26] ソフトウェア 開 発 工 程 における 用 語 構 造 と 翻 訳 辞 書 作 成 過 程 における 課 題, 小 川 清, 言 語 処 理 学 会 年 次 大 会 2000! [27] デジタル 設 計 工 学 における 言 語 の 対 称 性 についての 検 討, 小 川 清, 斉 藤 直 希, 渡 部 謹 二, 堀 武 司, 言 語 認 識 表 現 研 究 会,2008! [28] 形 式 手 法 における 言 語 の 対 称 性 についての 検 討, 小 川 清, 斉 藤 直 希, 渡 部 謹 二, 言 語 認 識 表 現 研 究 会,2009! [29] ビジュアル 博 物 館 第 48 巻 文 字 と 書 物, カレン ブルックフィールド, 同 朋 舎,1999! [30] LATEX 美 文 書 入 門, 奥 村 晴 彦, 技 術 評 論 社,1991! [31] サーチャー 試 験 データベース 検 索 技 術 者 試 験 傾 向 と 対 策, 小 川 清, 安 藤 敏 彦, 紀 伊 國 屋 書 店,1993! [32] プログラミング 言 語 教 育 の 自 然 言 語 教 育 方 式 の 応 用, 小 川 清, 言 語 認 識 表 現 研 究 会,1999

! [33] パソコンで 学 ぶエラー 対 策 テクニック 新 しいマン マシン インタ フェースを 考 える, 伏 見 諭, CBS 出 版,1986! [34] 組 込 み 開 発 者 におくるMISRA C:2004 C 言 語 利 用 の 高 信 頼 化 ガイ ド, SESSAME/MISRA-C 研 究 会, 日 本 規 格 協 会, 2006! [35] STARC RTL 設 計 スタイルガイドVerilog-HDL 編,2003! [36] 安 全 分 析, 状 態 記 述 と 形 式 手 法 に 着 目 した 安 全 教 育 とスキル, 堀 武 司, 小 川 清, 斉 藤 直 希, 渡 部 謹 二, 森 川 聡 久, 服 部 博 行, 安 全 工 学 シンポ ジウム, 2009! [37] プロセス 改 善 ナビゲーションガイドベストプラクティス 編,IPA/SEC, 2006! [38] 一 人 HAZOP を 組 み 合 わせた 効 率 的 な 分 析 作 業, 小 川 清, JAXA/IPA, 8th WOCS, 2011! [39] 今 昔 秀 歌 百 撰, 市 川 浩, 谷 田 貝 常 夫, 特 定 非 営 利 活 動 法 人 文 字 文 化 協 會, 2012! [40] 組 込 みシステム 開 発 事 例 集, 産 技 連 組 込 み 技 術 研 究 会, 堀 武 司, 小 川 清, 渡 部 謹 二, 斉 藤 直 希, ほか, 2006