あなたの仕様書は大丈夫？ 日本語文のあいまい度診断ツール『ClearDoc』でドキュメントをチェック
ウォーターフォール型の開発では、要件定義、設計、プログラミング、テスト、運用といった作業工程が時系列に進んでいく。開発当初に作成される要件定義や基本設計のドキュメントは、そのプロジェクトに関わる人たち全員が目にするため、そのドキュメントにあいまいな点や複雑な点などがあれば、後々の行程で問題が発生し、品質と生産性に影響する。この課題を解消するのが、株式会社シーイーシー PROVEQサービス事業部の開発した日本語文のあいまい度診断ツール『ClearDoc』だ。 ウォーターフォール型の開発では、要件定義、設計、プログラミング、テスト、運用といった作業工程が時系列に進んでいく。開発当初に作成される要件定義や基本設計のドキュメントは、そのプロジェクトに関わる人たち全員が目にするため、そのドキュメントにあいまいな点や複雑な点などがあれば、後々の工程で問題が発生し、品質と生産性に影響する。この課題を解消
悪文と良文から学ぶロジカル・ライティング 目次
ITエンジニアにとって文書作成技術は欠かせません。日常のメールのやりとりにはじまり、要件定義書、機能仕様書、企画の提案書など、上司やチーム、顧客などに対して、文章でコミュニケーションをとる機会がとても多いからです。 本連載では、論理的にわかりやすい文章を書く「ロジカル・ライティング」のノウハウを伝授します。ITエンジニアが日常的に用いるであろう文章を例に使い、どこが悪くてどう直せばいいのかといったポイントをわかりやすく解説します。実践すれば、誰でもすぐにわかりやすい文書が書けるようになるはずです。 連載目次 ●オリエンテーション ・ITエンジニアにとって「書く技術」とは？ ●文書の全体構成を組み立てられるようにする ・内容を大きく分けて項目を立てる ・適切な順番で項目を並べる ・話の階層をそろえる ●文章表現の基本ルールをマスターする ・主語と述語を対応させる ・修飾語と被修飾語をはっきり
理系のための文書作成術(1) ―― 開発文書を分かりやすく記述する
ソフトウェアやハードウェアなどの開発作業には，仕様書や設計書などの文書（ドキュメント）を読んだり書いたりすることが欠かせません．通常，開発文書は，読み手が理解しやすいように，正確で明快であることが求められます．さらに，開発文書としての内容が必要十分であることも求められます．それは，読み手が，開発文書の内容を理解するだけでなく，理解した情報を次に続く開発作業につなげなければならないからです．読み手にとって分かりにくい開発文書は，読み手の理解を妨げ，さらには開発作業の進み具合や作業そのものの成否にも影響を及ぼします． 本連載では，ソフトウェア開発を例にして，仕様書や設計書に散見される分かりにくい記述例を紹介しながら，次の論点を考察していきます． どんな文書が開発を妨げるのか 分かりやすい開発文書を書くにはどうしたらよいのか 文書作成をどのように開発業務に組み入れていけば，品質と生産性が上がるの
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
