20 KiB
20 KiB
<html>
<head>
</head>
Overview
Project Plan
Workflows
Current
<!-- Markdown content here -->
<h1 id="user-content-standard-terms-glossary" dir="auto">Standard Terms Glossary</h1>
<hr>
<p dir="auto"><strong>Process impact:</strong> This file as a dictionary of standard terms defined
as they are used across projects. Individual projects should not need to
edit this file. Writing out the definitions of terms and acronyms here
helps keep other documents more concise and easy to edit. Check the
<a href="<a href="http://readyset.tigris.org/templates/glossary-std" class="link">http://readyset.tigris.org/templates/glossary-std</a>">ReadySET glossary</a> for
updates.</p>
<p dir="auto">Jump to: <a href="#user-content-general_terms">General</a> |
<a href="#user-content-computer_science_and_technology_terms">Computer science & technology</a> |
<a href="#user-content-process_terms">Process</a> |
<a href="#user-content-development_tool_terms">Software development tools</a> |
<a href="#user-content-requirements_terms">Requirements</a> | <a href="#user-content-design_terms">Design</a> |
<a href="#user-content-design_goals_terms">Design goals terms</a> | <a href="#user-content-qa_terms">QA terms</a> |
<a href="#user-content-qa_goals_terms">QA goals terms</a> | <a href="#user-content-additional_standard_terms">Additional terms</a>|
<a href="/Suborbital-Systems/ReadySetGit/src/commit/8dd5821cf7b0d7355de95bf930615130a7cb68fe/glossary.html#glossary">Project terms</a></p>
<h3 id="user-content-general-terms" dir="auto">General Terms</h3>
<p dir="auto"> </p>
<h5 id="user-content-chipping-away" dir="auto">Chipping away</h5>
<p dir="auto">The process of removing sample text from templates when that text
does not apply to the current project. Often some of the sample text
will be kept or revised to fit the current project. Even if the
sample text does not fit the current project, it provides a reusable
example of how to phrase that type of description. The term
"chipping away" comes from an old joke: when a sculptor is asked how
he carved a marble statue of a horse, he replies "It was easy, I
just started with a big block of marble and chipped away everything
that did not look like a horse."</p>
<h5 id="user-content-attached-worksheet" dir="auto">Attached worksheet</h5>
<p dir="auto">The idea is similar to filling in an IRS form and using worksheets
to calculate subtotals or make specific decisions. That is to say,
there is a hierarchy to the templates: there are the main templates,
and then worksheets for specific topics. We have divided the
information into several files so that each file is focused on one
topic, and so that each file can be worked on by one person in a
reasonable amount of time.</p>
<h5 id="user-content-process-impact" dir="auto">Process impact</h5>
<p dir="auto">The process impact box on each template explains where the current
template fits into the software development process. It usually
includes a brief comment on who should create the document, and who
would be expected to make use of it. You can change the process
impact box, but you should not need to.</p>
<h5 id="user-content-checklist" dir="auto">Checklist</h5>
<p dir="auto">There are two kinds of checklists:</p>
<ul dir="auto">
<li>Many of the templates have a section with questions that help
you check your work in that template. Often the sample answers
to the questions prompt you to take some corrective action.</li>
<li>For design and code review meetings, there are links to
guidelines and checklists that help you identify common errors
in those artifacts.</li>
</ul>
<h5 id="user-content-sticky-note" dir="auto">Sticky note</h5>
<p dir="auto">The idea is similar to a post-it note attached to a document that
tells you do "sign here" or fill in a certain part. There are two
types of sticky notes:</p>
<ul dir="auto">
<li><em>TODO: Instructs you on how to fill in the template. This is the
minimum that you need to do. One of the main goals of ReadySET
is to help your team <em>quickly</em> carry out basic software
engineering activities. The TODO sticky notes make that easy by
making the templates more self-explanatory.</em></li>
<li>TIP: Helps you think of better ways to fill in the template. One
of the other main goals of ReadySET is to help your team make
better decisions that can make your whole project more
successful. The TIP sticky notes help with that.</li>
</ul>
<p dir="auto">After you have done what the sticky note says, you can delete the
sticky note.</p>
<h3 id="user-content-computer-science-and-technology-terms" dir="auto">Computer Science and Technology Terms</h3>
<p dir="auto"> </p>
<h5 id="user-content-api-application-programming-interface" dir="auto">::API (Application Programming Interface)</h5>
<p dir="auto">An API is a set of functions that one software component makes
available to other software components. That allows other programs
to "call" this program via direct function calls, or more indirect
communications such as <a href="#user-content-soap">SOAP</a> messages.</p>
<h5 id="user-content-soap" dir="auto">::SOAP</h5>
<p dir="auto">SOAP (Simple Object Access Protocol) is the message format used by
standard web services. It entails sending an XML document to a
server in order to invoke an operation on the server-side.
<a href="<a href="http://directory.google.com/Top/Computers/Programming/Internet/Web_Services/SOAP/?tc=1" class="link">http://directory.google.com/Top/Computers/Programming/Internet/Web_Services/SOAP/?tc=1</a>">More information on SOAP</a>.</p>
<h3 id="user-content-process-terms" dir="auto">Process Terms</h3>
<p dir="auto"> </p>
<h5 id="user-content-change-control-board-ccb" dir="auto">Change Control Board (CCB)</h5>
<p dir="auto">A group of people who review proposed changes to the project
requirements and/or source code to accept or reject changes in each
particular release. Proposed changes are usually rejected if they
introduce too much risk or would trigger additional effort (e.g.,
the need to redo a lot of testing on new code). A CCB is usually
composed of managers and representatives of other stakeholders such
as the QA group and key customers.</p>
<h5 id="user-content-feature-complete" dir="auto">Feature Complete</h5>
<p dir="auto">A release is called "feature complete" when the development team
agrees that no new features will be added to this release. New
features may still be suggested for later releases. More development
work needs to be done to implement all the features and
repair defects.</p>
<h5 id="user-content-code-complete" dir="auto">Code Complete</h5>
<p dir="auto">A release is called "code complete" when the development team agrees
that no entirely new source code will be added to this release.
There may still be source code changes to fix defects. There may
still be changes to documentation and data files, and to the code
for test cases or utilities. New code may be added in a
future release.</p>
<h5 id="user-content-internal-release-number" dir="auto">Internal Release Number</h5>
<p dir="auto">An internal release number is the number that the development team
gives each release. Internal release numbers typically count up
logically, i.e., they do not skip numbers. They may have many parts:
e.g., major, minor, patch-level, build number, RC number.</p>
<h5 id="user-content-external-release-number" dir="auto">External Release Number</h5>
<p dir="auto">External release numbers are the numbers that users see. Often, they
will be the same as the internal release number. That is especially
true if the product being built is a component intended to be reused
by another engineering group in the same development organization.
External release numbers can be different for products that
face competition. External release number are simpler, and may not
count up logically. E.g., a certain major ISP jumped up to version 8
of their client software because their competition had released
version 8. Later, the competition used version "10 Optimized" rather
than "10.1" or "11".</p>
<h5 id="user-content-release-number" dir="auto">Release Number</h5>
<p dir="auto">The term "release number" by itself refers to an
<a href="#user-content-external_release_number">external release number</a>. Users normally are not aware
of the existence of any internal release numbers.</p>
<h3 id="user-content-development-tool-terms" dir="auto">Development Tool Terms</h3>
<p dir="auto"> </p>
<h4 id="user-content-version-control-system" dir="auto">Version Control System</h4>
<p dir="auto">::DEFINITION1</p>
<h4 id="user-content-commit-log-message" dir="auto">Commit Log Message</h4>
<p dir="auto">::DEFINITION1</p>
<h4 id="user-content-issue-tracker" dir="auto">Issue Tracker</h4>
<p dir="auto">::DEFINITION1</p>
<h4 id="user-content-unit-testing-automation" dir="auto">Unit Testing Automation</h4>
<p dir="auto">::DEFINITION1</p>
<h4 id="user-content-automated-build-system" dir="auto">Automated Build System</h4>
<p dir="auto">::DEFINITION1</p>
<h4 id="user-content-source-code-analysis-tool" dir="auto">Source Code Analysis Tool</h4>
<p dir="auto">::DEFINITION1</p>
<h4 id="user-content-style-checker" dir="auto">Style Checker</h4>
<p dir="auto">::DEFINITION1</p>
<h4 id="user-content-source-code-formatter-pretty-printer" dir="auto">Source Code Formatter (Pretty Printer)</h4>
<p dir="auto">::DEFINITION1</p>
<h4 id="user-content-system-test-automation" dir="auto">System Test Automation</h4>
<p dir="auto">::DEFINITION1</p>
<h3 id="user-content-requirements-terms" dir="auto">Requirements Terms</h3>
<p dir="auto"> </p>
<h4 id="user-content-feature-specification" dir="auto">Feature specification</h4>
<p dir="auto">A feature specification focuses on one feature of a software product
and completely describes how that feature can be used. It includes a
brief description of the purpose of the feature, the input and
output, and any constraints. Individual bullet items give precise
details on all aspects of the feature. One feature may be used in
many different ways as part of many different use cases.</p>
<h4 id="user-content-use-case" dir="auto">Use case</h4>
<p dir="auto">The main part of a use case is a set of steps that give an example
of how an <a href="#user-content-actor">actor</a> can use the product to succeed at
a goal. These steps are called the "Main success scenario", and they
include both user intentions and system responses. One use case may
show how the actor uses several features to accomplish a goal.</p>
<h4 id="user-content-actor" dir="auto">Actor</h4>
<p dir="auto">A user or an external system that uses the system being built.</p>
<h3 id="user-content-design-terms" dir="auto">Design Terms</h3>
<p dir="auto"> </p>
<h4 id="user-content-term2" dir="auto">::TERM2</h4>
<p dir="auto">::DEFINITION2</p>
<h3 id="user-content-design-goals-terms" dir="auto">Design Goals Terms</h3>
<p dir="auto"> </p>
<h4 id="user-content-correctness" dir="auto">Correctness</h4>
<p dir="auto">This design correctly matches the given requirements.</p>
<h4 id="user-content-feasibility" dir="auto">Feasibility</h4>
<p dir="auto">This design can be implemented and tested with the planned amount of
time and effort.</p>
<h4 id="user-content-understandability" dir="auto">Understandability</h4>
<p dir="auto">Developers can understand this design and correctly implement it.</p>
<h4 id="user-content-implementation-phase-guidance" dir="auto">Implementation phase guidance</h4>
<p dir="auto">This design divides the implementation into components or aspects
that can correspond to reasonable implementation tasks.</p>
<h4 id="user-content-modularity" dir="auto">Modularity</h4>
<p dir="auto">Concerns are clearly separated so that the impact of most design
changes would be limited to only one or a few modules.</p>
<h4 id="user-content-extensibility" dir="auto">Extensibility</h4>
<p dir="auto">New features or components can be easily added later.</p>
<h4 id="user-content-testability" dir="auto">Testability</h4>
<p dir="auto">It is easy to test components of this design independently, and
information is available to help diagnose defects.</p>
<h4 id="user-content-efficiency" dir="auto">Efficiency</h4>
<p dir="auto">The design enables the system to perform functions with an
acceptable amount of time, storage space, bandwidth, and
other resources.</p>
<h4 id="user-content-ease-of-integration" dir="auto">Ease of integration</h4>
<p dir="auto">The components will work together.</p>
<h4 id="user-content-capacity-matching" dir="auto">Capacity matching</h4>
<p dir="auto">The architecture deploys components onto machines that provide
needed resources with reasonable total expense.</p>
<h4 id="user-content-expressiveness" dir="auto">Expressiveness</h4>
<p dir="auto">It allows for storage of all valid values and relationships</p>
<h4 id="user-content-ease-of-access" dir="auto">Ease of access</h4>
<p dir="auto">Application code to access stored data is simple</p>
<h4 id="user-content-reliability" dir="auto">Reliability</h4>
<p dir="auto">Stored data cannot easily be corrupted by defective code, concurrent
access, or unexpected process termination</p>
<h4 id="user-content-data-capacity" dir="auto">Data capacity</h4>
<p dir="auto">The system can store the amount of data needed.</p>
<h4 id="user-content-data-security" dir="auto">Data security</h4>
<p dir="auto">Protection of sensitive user and corporate data from unauthorized
access or modification</p>
<h4 id="user-content-performance" dir="auto">Performance</h4>
<p dir="auto">Data can be accessed quickly</p>
<h4 id="user-content-interoperability" dir="auto">Interoperability</h4>
<p dir="auto">The database or data files can be accessed and updated by other
applications</p>
<h4 id="user-content-intrusion-prevention" dir="auto">Intrusion prevention</h4>
<p dir="auto">Prevent, e.g., hackers opening a command shell on our server.</p>
<h4 id="user-content-abuse-prevention" dir="auto">Abuse prevention</h4>
<p dir="auto">Prevention of abuse (e.g., using our system to send spam).</p>
<h4 id="user-content-auditability" dir="auto">Auditability</h4>
<p dir="auto">All changes can be accounted for later.</p>
<h4 id="user-content-understandability-and-learnability" dir="auto">Understandability and learnability</h4>
<p dir="auto">Users can reasonably be expected to understand the UI at
first sight. Users will be able to discover additional features
without aid from other users or documentation, and they will be able
to recall what they have learned.</p>
<h4 id="user-content-task-support-and-efficiency" dir="auto">Task support and efficiency</h4>
<p dir="auto">The UI is well matched to the users' tasks and it can be used with a
reasonable number of clicks and keystrokes.</p>
<h4 id="user-content-safety" dir="auto">Safety</h4>
<p dir="auto">Users are not likely to accidentally produce an undesired result
(e.g., delete data, or send a half-finished email).</p>
<h4 id="user-content-consistency-and-familiarity" dir="auto">Consistency and familiarity</h4>
<p dir="auto">Users can apply their knowledge of similar UIs or UI standards to
this system.</p>
<h3 id="user-content-qa-terms" dir="auto">QA Terms</h3>
<p dir="auto"> </p>
<h4 id="user-content-bug" dir="auto">Bug</h4>
<p dir="auto"><em>n.</em> <strong>Deprecated</strong> since 1991. See <a href="#user-content-defect">defect</a>.</p>
<h4 id="user-content-error" dir="auto">Error</h4>
<p dir="auto"><em>v.</em> A mistaken thought in the developer's mind. Often caused by
miscommunication or bad assumptions. Errors can create
<a href="#user-content-defect">defects</a>. E.g., a developer might erroneously think that
the square root of -4 is -2.</p>
<h4 id="user-content-defect" dir="auto">Defect</h4>
<p dir="auto"><em>n.</em> The result of the developer's <a href="#user-content-error">error</a> embodied in the
product source code, initial data, or documents. E.g., a square root
function which allows negative numbers as arguments is defective.
Defects can be removed by changing the source code, initial data,
or document.</p>
<h4 id="user-content-fault" dir="auto">Fault</h4>
<p dir="auto"><em>n.</em> The execution of defective code. E.g., if a certain input is
provided to defective code, it may cause an exception, or go into an
infinite loop, or store an incorrect value in an internal variable.
A fault is not normally visible to users, only the
<a href="#user-content-failure">failure</a> is visible.</p>
<h4 id="user-content-failure" dir="auto">Failure</h4>
<p dir="auto"><em>n.</em> The user-visible result of a <a href="#user-content-fault">fault</a>. E.g., an error
message or an incorrect result. This is evidence that can be
reported in a defect report. Developers use failure evidence during
debugging to eventually find and remove <a href="#user-content-defect">defects</a>.</p>
<h3 id="user-content-qa-goals-terms" dir="auto">QA Goals Terms</h3>
<p dir="auto"> </p>
<h4 id="user-content-functionality-gt-correctness" dir="auto">Functionality > Correctness</h4>
<p dir="auto">Correctness is the most basic quality goal. It means that, when
valid inputs are given and the system is in a valid state and under
reasonable load, the system's behavior and results will be correct.</p>
<h4 id="user-content-functionality-gt-robustness" dir="auto">Functionality > Robustness</h4>
<p dir="auto">Robustness is the system's ability to gracefully handle
invalid inputs. It should never be possible for any user input to
crash the system or corrupt data, even if that user input is
abnormal, unexpected, or malicious.</p>
<h4 id="user-content-functionality-gt-accuracy" dir="auto">Functionality > Accuracy</h4>
<p dir="auto">Accuracy refers to the mathematical precision of calculations done
by the system. Any system that does numeric calculations must
consider accuracy, e.g., financial or scientific applications.</p>
<h4 id="user-content-functionality-gt-compatibility" dir="auto">Functionality > Compatibility</h4>
<p dir="auto">Systems that claim to follow standards or claim compatibility with
existing systems must adhere to the relevant file formats,
protocols, and APIs. The relevant standards are linked at the top of
this document.</p>
<h4 id="user-content-functionality-gt-factual-correctness" dir="auto">Functionality > Factual correctness</h4>
<p dir="auto">Is the data in the system a true representation of the real world?
Any system that contains initial data or gathers data about the real
world should be sure that the data is factually correct. E.g., a tax
preparation program should embody correct and up-to-date facts about
tax law.</p>
<h4 id="user-content-usability-gt-understandability-and-readability" dir="auto">Usability > Understandability and Readability</h4>
<p dir="auto">Users need to understand the system to use it. The basic metaphor
should be understandable and appropriate to user tasks. Some defects
in understandability include unclear metaphors, poor or hard-to-see
labels, lack of feedback to confirm the effects of user actions, and
missing or inadequate on-line help.</p>
<h4 id="user-content-usability-gt-learnability-and-memorability" dir="auto">Usability > Learnability and Memorability</h4>
<p dir="auto">Every user interface contains some details that users will need to
learn and remember. E.g., Alt-F to open the "File" menu. UI cues and
rules can make these details easier to learn and remember. E.g., the
"F" is underlined and, as a rule, the first letter is usually the
accelerator key.</p>
<h4 id="user-content-usability-gt-task-support" dir="auto">Usability > Task support</h4>
<p dir="auto">This is the quality of match between user tasks and the system's UI.
Task support defects are cases where the system forces the user to
take unnatural steps to accomplish a task or where the user is given
no support for a difficult step in a task. E.g., must the user
invent an 8-character filename for their "Christmas card list"?
E.g., must users total their own tax deductions?</p>
<h4 id="user-content-usability-gt-efficiency" dir="auto">Usability > Efficiency</h4>
<p dir="auto">Users should be able to accomplish common tasks with
reasonable effort. Common tasks should be possible with only one or
two steps. The difficulty of each step should also be considered.
E.g., does the user have to remember a long code number or click on
a very small button?</p>
<h4 id="user-content-usability-gt-safety" dir="auto">Usability > Safety</h4>
<p dir="auto">Humans are error-prone, but the negative effects of common errors
should be limited. E.g., users should realize that a given command
will delete data, and be asked to confirm their intent or have the
option to undo.</p>
<h4 id="user-content-usability-gt-consistency-and-familiarity" dir="auto">Usability > Consistency and Familiarity</h4>
<p dir="auto">Users should be able to apply their past experience from other
similar systems. This means that user interface standards should be
followed, and common conventions should be used whenever possible.
Also, UI elements that appear in several parts of the UI should be
used consistently, unless another UI quality takes priority. E.g.,
if most currency entry fields do not require a dollar-sign, then one
that does demand it is a consistency defect, unless there is a real
chance that the user is dealing with another currency on that step
in his/her task.</p>
<h4 id="user-content-usability-gt-subjective-satisfaction" dir="auto">Usability > Subjective satisfaction</h4>
<p dir="auto">Users should feel generally satisfied with the UI. This is a
subjective quality that sums up the other user interface qualities
as well as aesthetics.</p>
<h4 id="user-content-security" dir="auto">Security</h4>
<p dir="auto">The system should allow usage only by authorized users, and restrict
usage based on permissions. The system should not allow users to
side-step security rule or exploit security holes. E.g., all user
input should be validated and any malicious input should
be rejected.</p>
<h4 id="user-content-reliability-gt-consistency-under-load" dir="auto">Reliability > Consistency under load</h4>
<p dir="auto">Every system has some capacity limits. What happens when those
limits are exceeded? The system should never lose or corrupt data.</p>
<h4 id="user-content-reliability-gt-consistency-under-concurrency" dir="auto">Reliability > Consistency under concurrency</h4>
<p dir="auto">Systems that allow concurrent access by multiple users, or that use
concurrency internally, should be free of race conditions
and deadlock.</p>
<h4 id="user-content-reliability-gt-availability-under-load" dir="auto">Reliability > Availability under load</h4>
<p dir="auto">Every system has some capacity limits. What happens when those
limits are exceeded? The system should continue to service those
requests that it is capable of handling. It should not crash or stop
processing all requests.</p>
<h4 id="user-content-reliability-gt-longevity" dir="auto">Reliability > Longevity</h4>
<p dir="auto">The system should continue to operate as long as it is needed. It
should not gradually use up a limited resource. Example longevity
defects include memory leaks or filling the disk with log files.</p>
<h4 id="user-content-efficiency-1" dir="auto">Efficiency</h4>
<p dir="auto">The system's operations should execute quickly, with reasonable use
of machine and network resources. E.g., if one user does one
operation, it should execute efficiently.</p>
<h4 id="user-content-scalability" dir="auto">Scalability</h4>
<p dir="auto">Scalability is a general quality that holds when the system
continues to satisfy its requirements when various usage parameters
are increased. E.g., a file server might be scalable to a high
number of users, or to very large files or very high capacity disks.
Several specific scalability goals are listed below.</p>
<h4 id="user-content-scalability-gt-performance-under-load" dir="auto">Scalability > Performance under load</h4>
<p dir="auto">This is a specific type of scalability goal dealing with the
performance of the system at times when it is servicing many
requests from many users.</p>
<h4 id="user-content-scalability-gt-large-data-volume" dir="auto">Scalability > Large data volume</h4>
<p dir="auto">This is a specific type of scalability goal dealing with the ability
for the system to handle large data sets. Operations should continue
to be correct and efficient as data set size increases. Furthermore,
the user interface should still be usable as the data presented to
users increases in length.</p>
<h4 id="user-content-operability" dir="auto">Operability</h4>
<p dir="auto">The long-term needs of system administrators should be
reliably supported. E.g., is the system easy to install? Can the
administrator recover from a crash? Is there sufficient log output
to diagnose problems in the field? Can the system's data be backed
up without downtime? Can the system be upgraded practically?</p>
<h4 id="user-content-maintainability-gt-understandability" dir="auto">Maintainability > Understandability</h4>
<p dir="auto">Will it be easy for (future) developers to understand how the system
works?</p>
<h4 id="user-content-maintainability-gt-evolvability" dir="auto">Maintainability > Evolvability</h4>
<p dir="auto">Can the system easily be modified and extended over time?</p>
<h4 id="user-content-maintainability-gt-testability" dir="auto">Maintainability > Testability</h4>
<p dir="auto">Can the system easily be tested? Do the requirements precisely
specify possible inputs and the desired results? Can the system be
tested in parts? When failures are observed, can they be traced back
to defects in specific components (i.e., debugging)? Is testing
practical with the available testing tools?</p>
<h3 id="user-content-additional-standard-terms" dir="auto">Additional Standard Terms</h3>
<p dir="auto">For additional standard terms, see the following reference sites:</p>
<ul dir="auto">
<li><a href="<a href="http://www.dictionary.com/" class="link">http://www.dictionary.com/</a>">Dictionary.com</a></li>
<li><a href="<a href="http://www.whatis.com/" class="link">http://www.whatis.com/</a>">Whatis.com</a></li>
<li><a href="<a href="http://www.nist.gov/dads/" class="link">http://www.nist.gov/dads/</a>">NIST Dictionary of Algorithms and Data Structures</a></li>
<li><a href="http:/<a href="http://foldoc.doc.ic.ac.uk/foldoc/index.html" class="link">http://foldoc.doc.ic.ac.uk/foldoc/index.html</a>">Free on-line dictionary of computing</a></li>
<li><a href="<a href="http://www-3.ibm.com/ibm/terminology/goc/gocmain.htm" class="link">http://www-3.ibm.com/ibm/terminology/goc/gocmain.htm</a>">IBM's glossary of computing terms</a></li>
<li><a href="<a href="http://www.jargon.org/" class="link">http://www.jargon.org/</a>">Jargon File</a></li>
</ul>
<!-- End Markdown content -->
</html>