A Guide to Writing Good Requirements

In: Computers and Technology

Submitted By wjdawud01
Words 6521
Pages 27
A Guide to Writing Good Requirements

QA Check Points

Enterprise Program Management

November 22, 2009

Gathered By:

Wail A. Dawud; Lead Enterprise Analyst

Original Author

Ivy Hooks for Third NCOSE Symposium and Published in the Proceedings of the Third International Symposium of the INCOSE - Volume 2, 1993.

Disclaimer: the original author is the SOLE owner of this document and should credited with it. The only difference between the original documents and this document is formatting and some added clarification of certain examples and follow up analysis..

Table of Contents

1. introduction 4
2. good requirements 5
3. Common problems 6
3.1 Bad assumptions 7
3.2 writing implementation (how) instead of requirements (what) 8
3.3 describing operations instead of requirements 10
3.4 using incorrect terms 11
3.5 using incorrect sentence structure or bad grammar 13
3.6 missing requirements 16
3.7 over specifying 18
4. writing quality requirements – qa check points 20
4.1 chatacteristics of quality requirement statements 21
4.1.1 correct 22
4.1.2 feasible 23
4.1.3 necessary 24
4.1.4 priotirized 25
4.1.5 unambiguous 26
4.1.6 verifiable 27
4.1.7 Complete 28
4.1.8 Consistent 29
4.1.9 modifiable 30
4.1.10 traceable 31
5. reviewing requirements for quality 32
5.1 example #1 33
5.2 example #2 34
5.3 example #3 35
5.4 example #4 36
6. Revision History 37

1. introduction

This document will address what makes good requirements. It will cover some of the most common issues that are encountered in writing requirements. The information provided in this document will be used as training tool for analysts to help them write quality requirements. However, it should not replace the organization’s sponsored artifacts and strategies. This document can be used to bring an acceptable level of unified process among…...

Similar Documents

Writing Guide

...Writing Resource Guide Version 1.0, Fall 2002 By Lucy Honig Contents Introduction Writing for the MPH: A W/Rite of Passage A message to BUSPH students Useful writing references for SPH students The writing process: some practical tips Common problems The Paramedic Method of editing Referencing: Styles of citation Citation of electronic sources A note about plagiarism Using direct quotations and paraphrases Boston University writing resources 6 9 10 15 21 25 27 29 31 2 3 INTRODUCTION Public health professionals write all the time. Writing is an important tool for bringing about changes in policy, practice, public understanding, and health behaviors. You may create exciting and effective methods for addressing these matters, but if you cannot effectively communicate those ideas it is as if they do not exist at all. Furthermore, the process of writing helps to sharpen one’s ideas; good writing requires good thinking. Writing assignments in SPH courses have a variety of goals: to test your knowledge, to foster critical thinking, to enhance your research skills, to assess your communication skills and to prepare you for the myriad writing tasks you will encounter in your professional work. We expect you to carry out writing assignments with the thought and skill consistent with graduate level work, and we believe the improvement of writing skills is essential for the health of our profession. An MPH degree implies that you are equipped with the many competencies that are...

Words: 9334 - Pages: 38

Guide to Writing a Basic Essay

...Guide to Writing a Basic Essay An essay can have many purposes, but the basic structure is the same no matter what. You may be writing an essay to argue for a particular point of view or to explain the steps necessary to complete a task. Either way, your essay will have the same basic format. If you follow a few simple steps, you will find that the essay almost writes itself. You will be responsible only for supplying ideas, which are the important part of the essay anyway. Don't let the thought of putting pen to paper daunt you. Get started! These simple steps will guide you through the essay writing process: • • • • Decide on your topic. Prepare an outline or diagram of your ideas. Write your thesis statement. Write the body. • • • • • • Write the main points. Write the subpoints. Elaborate on the subpoints. Write the introduction. Write the conclusion. Add the finishing touches. Choose a Topic for Your Essay Topic Has Been Assigned You may have no choice as to your topic. If this is the case, you still may not be ready to jump to the next step. Think about the type of paper you are expected to produce. Should it be a general overview, or a specific analysis of the topic? If it should be an overview, then you are probably ready to move to the next step. If it should be a specific analysis, make sure your topic is fairly specific. If it is too general, you must choose a narrower subtopic to discuss. For example, the topic "KENYA" is a general one. If your objective......

Words: 2605 - Pages: 11

Guide for Writing Proposal

...Guide for Writing Project Proposals This is a summary of how to write good, concise proposals for course projects. The recommended lengths of sections are given assuming a document length of 2 to 4 pages. Sample Outline The following is a sample outline for a project proposal. Note that all questions for a section may not apply to your proposal, and should be used as a general guide only. You may use your own creativity appropriately. 1. Introduction (1 paragraphs) * Motivation Sentence * Summarize the problem (1 or 2 sentences) * Summarize the proposed solution, if any (1 or 2 sentences) * Describe format of rest of proposal (sections, etc.) 2. Motivation (2 paragraphs) * What is the history of the problem? * Why is this problem interesting? * When and why does the problem occur? * Is the problem already solved? What is done now? * Are there any similar systems or solutions to the one you propose? If so, reference and very briefly explain them. * Are there are possible improvements to current solutions? 3. Project Summary (1 paragraph) * What in general will this project achieve? (Do not delve into details.) 4. Project Details (Planning) * Project Description (2 paragraphs + figures) * Describe the project and how it will be managed. * Diagrams and figures are useful here if appropriate. * What data will you use and how will they be......

Words: 315 - Pages: 2

A Good Example of Writing Essay

...complications in low-context cultures. In a high-context culture, the job is given to the person who will do the best work and whom you can trust and control. In a low-context culture, one tries to make the specifications so precise that a builder is forced by the threat of legal sanction to do a good job. A building contractor in Japan is likely to say, “What has that piece of paper got to do with the situation? If we can't trust each other enough to go ahead without it, why bother?” Although countries can be classified as high or low context in their overall tendency, there are exceptions to the general tendency. These exceptions are found in subcultures. The United States, for example, is a low-context culture with subcultures that operate in the high-context mode. The world of the central banker, for example, is a "gentleman's" world, that is, a high-context culture. Even during the most hectic days in the foreign exchange markets, a central banker's word is sufficient for him or her to borrow millions of dollars. Actions initiated on the telephone are confirmed in writing days later. A person's word is relied upon, even though the general rule in the lowcontext culture is "get it in writing." Another high-context subculture in the United States is the Mafia, which has imported the high-context culture of Sicily to the United States and has maintained this culture with language, ritual, and a strong sense of distinct identity. These examples illustrate the ways of a......

Words: 890 - Pages: 4

A Guide to Writing the Dissertation Literature

...A peer-reviewed electronic journal. Copyright is retained by the first or sole author, who grants right of first publication to the Practical Assessment, Research & Evaluation. Permission is granted to distribute this article for nonprofit, educational purposes if it is copied in its entirety and the journal is credited. Volume 14, Number 13, June 2009 ISSN 1531-7714 A Guide to Writing the Dissertation Literature Review Justus J. Randolph Walden University Writing a faulty literature review is one of many ways to derail a dissertation. This article summarizes some pivotal information on how to write a high-quality dissertation literature review. It begins with a discussion of the purposes of a review, presents taxonomy of literature reviews, and then discusses the steps in conducting a quantitative or qualitative literature review. The article concludes with a discussion of common mistakes and a framework for the self-evaluation of a literature review. Writing a faulty literature review is one of many ways to derail a dissertation. If the literature review is flawed, the remainder of the dissertation may also be viewed as flawed, because “a researcher cannot perform significant research without first understanding the literature in the field” (Boote & Beile, 2005, p. 3). Experienced thesis examiners know this. In a study of the practices of Australian dissertation examiners, Mullins and Kiley (2002) found that, Examiners typically started reviewing a dissertation with...

Words: 8324 - Pages: 34

Essay Writing Guide

...Levi’s Essay Writing Guide Compiled by Levi Whitten-Connolly 15 September 2010 Page: 1 Below I have prepared a few pages to help guide you write a few essays – these are taken from my own notes. Page: 1 © 2010 Levi Whitten-Connolly (levi@whitten-connolly.net) Levi’s Essay Writing Guide Compiled by Levi Whitten-Connolly 15 September 2010 Page: 2 Page: 2 © 2010 Levi Whitten-Connolly (levi@whitten-connolly.net) Levi’s Essay Writing Guide Compiled by Levi Whitten-Connolly 15 September 2010 Page: 3 Page: 3 © 2010 Levi Whitten-Connolly (levi@whitten-connolly.net) Levi’s Essay Writing Guide Compiled by Levi Whitten-Connolly 15 September 2010 Page: 4 Page: 4 © 2010 Levi Whitten-Connolly (levi@whitten-connolly.net) Levi’s Essay Writing Guide Compiled by Levi Whitten-Connolly Mind Maps 15 September 2010 Page: 5 Mind Maps are a great way to organise your essay before you write it – they are als a great tool for writing down key information points before an exam. Below is an example of a mind map – make sure when you write one out that you colour code each section as your brain remembers things better this way. Page: 5 © 2010 Levi Whitten-Connolly (levi@whitten-connolly.net) Levi’s Essay Writing Guide Compiled by Levi Whitten-Connolly 15 September 2010 Page: 6 Page: 6 © 2010 Levi Whitten-Connolly (levi@whitten-connolly.net) Levi’s Essay Writing Guide Compiled by Levi......

Words: 251 - Pages: 2

Good Writing Case

...Write a Case Study What Is a Case Study? A case study is a puzzle that has to be solved. The first thing to remember about writing a case study is that the case should have a problem for the readers to solve. The case should have enough information in it that readers can understand what the problem is and, after thinking about it and analyzing the information, the readers should be able to come up with a proposed solution. Writing an interesting case study is a bit like writing a detective story. You want to keep your readers very interested in the situation. A good case is more than just a description. It is information arranged in such a way that the reader is put in the same position as the case writer was at the beginning when he or she was faced with a new situation and asked to figure out what was going on. A description, on the other hand, arranges all the information, comes to conclusions, tells the reader everything, and the reader really doesn't have to work very hard. When you write a case, here are some hints on how to do it so that your readers will be challenged, will "experience" the same things you did when you started your investigation, and will have enough information to come to some answers. There are three basic steps in case writing: research, analysis, and the actual writing. You start with research, but even when you reach the writing stage you may find you need to go back and research even more information. The Research Phase: 1. Library and Internet......

Words: 2821 - Pages: 12

Writing Guide

...Axia College First-Year Sequence Short Form Writing Style Handbook 2009 © 2009, 2007 University of Phoenix. ALL RIGHTS RESERVED. The text of this publication, or any part thereof, may not be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, storage in an information retrieval system, or otherwise, without prior permission of University of Phoenix. Edited in accordance with The Apollo Group editorial standards and practices. Introduction This short form writing style guide has been specially created for the First-Year Sequence of courses at Axia College. It is based on the more complete Axia College’s Writing Style Handbook that you will rely on and be held accountable for in your courses after your first year at Axia College. The purpose of this guide is to provide the basic rules necessary for writing papers that are consistent in style, formatting, and respect the intellectual property rights of experts whose material you refer to in your formal papers. If you have any questions about what these rules mean or how to use them, always check with your instructor. Font Styles • All text must be written in the same font. • Use Times New Roman, Arial, or Courier, 12-point size. • Use italics sparingly for emphasis; do not use bold, underlining, or all capital letters. Margins • Use 1-inch margins on all sides of each page. • Justify the left side of the page, but leave......

Words: 1286 - Pages: 6

The Guide for Writing Word Documents

...The Guide for Writing Word Documents in Microsoft Word for EasyChair Publication Andrei Voronkov1 and Kryštof Hoder1 1 University of Manchester, Manchester, U.K. andrei@voronkov.com, hoderk@cs.man.ac.uk Abstract In order to ease the lives of authors, editors, and trees, we present a manual and an example of the use of Microsoft Word and similar tools for creating documents for EasyChair-based electronic and on-paper publishing of workshop and conference proceedings. 1 Introduction The styles and parameters of this guide are designed for compliance with the requirements for publication in the EasyChair conference system (Voronkov, 2004), and are also applicable to the Procedia publications series by Elsevier Science. EasyChair is a free conference management system that is flexible, easy to use, and has many features to make it suitable for various conference models. It is currently probably the most commonly used conference management system (Voronkov, 2004). The use of EasyChair and this style for creating Procedia volumes is a pilot project between Elsevier Science and EasyChair. EasyChair publications accept documents written either in LaTeX or using a docx document format, which can be produced by Microsoft Word or LibreOffice. This guide explains how to produce the docx format in Microsoft Word. To achieve high quality of volumes, both LaTeX and Word documents should have the same layout and similar styles. This guide is provided for the users of Microsoft Word...

Words: 1834 - Pages: 8

Analytic Scoring Guide for Writing

...A3.8.2015 Design an analytic scoring guide for a compositing writing which has a total score of 15 marks. Compositing Writing Profile Student - Date - Topic - SCORE | LEVEL | CRETERIA | CONTENT | 4 – 3.5 | EXCELLENT TO VERY GOOD • relevant to assigned topic • exceptionally clear, focused, engaging with relevant, strong supporting detail | | 3 – 2.5 | GOOD TO AVERAGE • clear, focused, interesting ideas with appropriate detail • evident main idea with some support | | 2 – 1.5 | FAIR TO POOR • purpose and main idea is unclear • irrelevant detail | | 1 – 0.5 | VERY POOR • lack of central ideas • development is minimal | ORGANIZATION | 3 – 2.5 | EXCELLENT TO VERY GOOD • effectively organized in logical and creative manner • logical engaging intro and conclusion | | 2 – 1.5 | GOOD TO AVERAGE • strong order and structure • organization is appropriate | | 1.25 – 1 | FAIR TO POOR • lack of structure and disorganized • weak intro and conclusion | | 0.5 | VERY POOR • lack of coherence • no appropriate introduction or conclusion | VOCABULARY | 3 – 2.5 | EXCELLENT TO VERY GOOD • effective word/idiom choice and usage • mastery word form • appropriate register | | 2 - 1.5 | GOOD TO AVERAGE • appropriate choice of word • occasional errors of word/idiom form, choice, usage but comprehensible | | 1.25 – 1 | FAIR TO POOR • limited range of words • frequent errors • meaning confused | | 0.5 | VERY POOR •......

Words: 362 - Pages: 2

Guide for Report Writing

...What is a report? A report ‘reports’ on something in a concise, formal way using clearly defined sections presented in a standard format, which tell the reader what you did, why and how you did it and what you found. It is the formal writing up of a practical experiment, project or research investigation. A report is written in a way which presumes that the reader knows nothing about your experiment or research. It is usually written more concisely than an essay, with headings and sub-headings and perhaps bullet-point recommendations, etc. A research report must be written in sufficient detail so that someone reading it would be able to replicate your research exactly. It usually contains arguments and critical evaluation to support a proposed course of action, or to evaluate a business issue. BEFORE YOU START WRITING… • Firstly, check with your lecturer and the module handbook for precise instructions, i.e. the prescribed report structure, word count, deadline. All UHBS reports are module and assignment specific, so this guide only gives a very general idea of structure and content. • Be very detail minded. All UHBS reports will require accurate referencing, good clear English, professional presentation, i.e. clear structure, coherent, free of spelling, grammatical and punctuation errors. • If you are compiling a group report, assign roles. One person in the group could be assigned the role of ‘editor’ to finally ensure the report is put......

Words: 4226 - Pages: 17

What Is Good Writing

...don’t necessarily know what is good writing. Good writing can be displayed in many different ways. Though this is a difficult question to answer when looking at writer’s text, it is an even tougher question to apply to your own writing. So what is good writing? Good writing can be defined as well put together, organized, a piece of text that is fully developed, but it all depends on the quality this text has, I think good writing breaks expectations. By breaking expectation I mean, as writer you should be able to create tension, violate the genre, and create something that has never been seen before in your text. Game of Thrones is an excellent example of how good writing breaks expectations. The writer begins his series in Westeros, which is the land of the Seven Kingdoms. In this universe, there is only two seasons that can last for years, either summer bounty or winter hardship. Realistically there are four seasons, and each season last three months. In the Game of Thrones world there this is not the case. As you read the books you come to realize these seasons do not last three months, or four, or five. They last years. This makes the reader think about if the writer was imagining a different world, or if the people back then only thought there was two seasons. As well as the reader it makes me imagine if there could possibly be only two seasons because after all fall and winter are similar as too spring and summer. I feel like his writing creates dimension to me as......

Words: 1016 - Pages: 5

Visual Guide to Essay Writing

...A VISUAL GUIDE TO ESSAY WRITING Dr Valli Rao, Associate Professor Kate Chanock, and Dr Lakshmi Krishnan use a visual approach to walk students through the most important processes in essay writing for university: formulating, refining, and expressing academic argument. ‘MetamorTHESIS‘ Your main argument or thesis is your position in answer to the essay question. It changes and develops as you undertake your reading and research towards the essay. how to develop & communicate academic argument “I love the way the authors explain what an argument is. I also love the way they justify holding opinions in an academic context … A Visual Guide to Essay Writing shows you excellently how to communicate with your marker by employing your ‘authorial voice’.” - Dr Alastair Greig Head, School of Social Sciences The Australian National University Valli Rao Kate Chanock Lakshmi Krishnan “This is a great book ... clear, useful, beautifully conceived and produced ... an intriguing approach, one that will make sense to students and really assist their essay writing skills.” - Brigid Ballard & John Clanchy authors of the international best-seller Essay writing for students: a practical guide How effective structure supports reasoned argument in essays1 Discipline/field Topic Underlying question Introduce discipline/field/context and topic Roughly, 10–15% of essay length Why is this topic interesting from the perspective of the......

Words: 20948 - Pages: 84

Guide to Writing Philosophy Paper

...HARVARD COLLEGE Writing Center WRITING CENTER BRIEF GUIDE SERIES A Brief Guide to Writing the Philosophy Paper The Challenges of Philosophical Writing The aim of the assignments in your philosophy classes is to get you doing philosophy. But what is philosophy, and how is it to be done? The answer is complicated. Philosophers are often motivated by one or more of what we might call the “Big Questions,” such as: How should we live? Is there free will? How do we know anything? or, What is truth? While philosophers do not agree among themselves on either the range of proper philosophical questions or the proper methods of answering them, they do agree that merely expressing one’s personal opinions on controversial topics like these is not doing philosophy. Rather, philosophers insist on the method of first attaining clarity about the exact question being asked, and then providing answers supported by clear, logically structured arguments. An ideal philosophical argument should lead the reader in undeniable logical steps from obviously true premises to an unobvious conclusion. A negative argument is an objection that tries to show that a claim, theory, or argument is mistaken; if it does so successfully, we say that it refutes it. A positive argument tries to support a claim or theory, for example, the view that there is genuine free will, or the view that we should never eat animals. Positive philosophical arguments about the Big Questions that are ideal are extremely hard to......

Words: 4785 - Pages: 20

Techincal Writing Is Good for You

...Technical writing is not just for college assignments. In my many job searches there have been common requirements or sought after job skills that employers look for in a potential employee candidate. These skills are easily dismissed by most with a thought process that they could easily replicate or fake their way through. The jobs skills I am talking about are normally summarized as good written communication, and organization. Technical writing teaches these disciplines and help you improve your ability to shine in a potential career. To fully explain these concepts I will explain first on how technical writing affects your organizational skills. In the process of writing a project paper or an essay, you begin to notice a sense that you need to not only prove a point but you must properly order your thoughts to make what you are writing about to be clear to the reader. Something as simple writing a thesis requires a process of organization. In this first paragraph you need to grab the reader’s attention, introduce an idea, and follow up the idea with how you plan to prove your point in a short amount of sentences. This requires thinking through the thesis and organizing how you want the paper to follow through with what you are claiming. You begin to organize your thoughts and sorting through the research you have done. You prioritize the claims and start to form this simple idea into an organized paper in which anyone should be able to read without feeling lost. Good......

Words: 395 - Pages: 2

The Newsroom | الراتنج الحرف | Forrest Gump