#author("2024-01-07T00:57:56+00:00","default:hotate","hotate") #author("2024-03-15T22:23:08+00:00","default:hotate","hotate") #contents &tag(仕様書,日本語,校正); * 情報 [#k3c7bd4a] - [[プロジェクト成功確率向上の近道とは?(2):サンプル例に見る機能仕様書の基本的な書き方&読みやすくする7つのテクニック (1/3) - @IT>http://www.atmarkit.co.jp/ait/articles/1502/06/news013.html]] Joelの機能仕様書は、ユーザー視点でソフトウエアの動作や画面の仕様(=いわゆるユーザー体験の仕様)を記述し、ユーザーと開発者とが情報共有(共通理解)をするためのドキュメントです。 - [[ドキュメント作成スキル向上を目指す人向けおすすめ記事まとめ - Qiita>https://qiita.com/yasuoyasuo/items/1eb7298f91a44dce7abc]] この記事では、まず冒頭でドキュメントの作成に求められると思うことを整理した上で、そのスキル獲得に役立つと思われる記事や書籍を集めてみました。 * [[IPA]] [#x933378b] - [[発注者ビューガイドラインの公開:IPA 独立行政法人 情報処理推進機構>https://www.ipa.go.jp/sec/softwareengineering/reports/20080710_3.html]] 外部設計工程における、発注者にわかりやすい仕様の記述方法及び合意方法を世の中に広く普及することを目的としています。 * 手順書 [#c04d04fd] + [[自己流の手順書フォーマットを公開してみた | DevelopersIO>https://dev.classmethod.jp/articles/non-97-operation-manual/]] みなさんは自己流または、組織やプロジェクトで定められた手順書のフォーマットはありますか? 私は自己流の手順書フォーマットがあります。 -- コメント:[[VisualStudioCode]]での文書作成、[[Markdown]]での章ナンバリング方法、HTML/[[PDF]]エクスポートの比較あり。(2021/11/14) + [[AWS テクニカルサポートで得た暗黙知をまとめてみた | DevelopersIO>https://dev.classmethod.jp/articles/technical-support-tips/]] 例: 何をお願いしたいか不明瞭 × 〜という事象が発生します。確認をお願い致します。 言われた通りに「確認しました。」という回答ではほとんどのパターンが満足されません。(理不尽) ○ 〜という事象が発生します。この事象が発生しないようにしたいので、対策を教えてください。 -- コメント:事例が多く実践的な内容が参考になる。([[2021]]/11/14) + [[テクニカルライティングの基本 - Speaker Deck>https://speakerdeck.com/naohiro_nakata/technicalwriting]] テクニカルライティングの基本を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 -- [[テクニカルライティングの基本 2023年版 - Speaker Deck>https://speakerdeck.com/naohiro_nakata/technicalwriting2023]] (2023/6/23) -- コメント:実践的な内容が多く参考になる。([[2022]]/08/14) * 校正 [#v9d9fd57] - [[パワポエンジニアの憂鬱を軽減する誤字/表記揺れ検出ツールを作った物語 - Qiita>https://qiita.com/youwht/items/062c41c88829fcf25107]] PPTXやXLSXからテキストデータを抽出 完全オフライン & 前提ツール不要で動作 誤字/表記揺れを、複数ファイル横断で検知 -- [[パワポエクセル一発リント君の詳細情報 : Vector ソフトを探す!>https://www.vector.co.jp/soft/winnt/business/se519740.html]] LINT_for_PPTX_XLSX.zip -- 関連:[[Python]], [[Janome]], [[自然言語処理]] - [[文書ファイルをD&Dするだけのシンプルな文書校正ツールが「はてブ」で話題に - やじうまの杜 - 窓の杜>https://forest.watch.impress.co.jp/docs/serial/yajiuma/1323262.html]] (2021/5/10) 「textract」というツールで「Microsoft Office」ドキュメントなどからテキストを抽出し(PDF文書では「xpdf」を利用)、それをテキスト校正支援ツール「textlint」でチェックする処理を「electron」でGUI化しただけだそうですが... -- 関連:[[textlint]] #taglist(tag=校正) * 関連 [#zca693e9] #taglist(tag=仕様書)