ma-agents 2.13.0 → 2.13.2

package/lib/mil498-templates/SSDD.md

@@ -0,0 +1,154 @@
+# 1. Scope.
+
+This section shall be divided into the following paragraphs.
+
+## 1.1 Identification.
+
+This paragraph shall contain a full identification of the system to which this document applies, including, as applicable, identification number(s), title(s), abbreviation(s), version number(s), and release number(s).
+
+## 1.2 System overview.
+
+This paragraph shall briefly state the purpose of the system to which this document applies. It shall describe the general nature of the system; summarize the history of system development, operation, and maintenance; identify the project sponsor, acquirer, user, developer, and support agencies; identify current and planned operating sites; and list other relevant documents.
+
+## 1.3 Document overview.
+
+This paragraph shall summarize the purpose and contents of this document and shall describe any security or privacy considerations associated with its use.
+
+# 2. Referenced documents.
+
+This section shall list the number, title, revision, and date of all documents referenced in this document. This section shall also identify the source for all documents not available through normal Government stocking activities.
+
+# 3. System-wide design decisions.
+
+This section shall be divided into paragraphs as needed to present system-wide design decisions, that is, decisions about the system's behavioral design (how it will behave, from a user's point of view, in meeting its requirements, ignoring internal implementation) and other decisions affecting the selection and design of system components. If all such decisions are explicit in the requirements or are deferred to the design of the system components, this section shall so state. Design decisions that respond to requirements designated critical, such as those for safety, security, or privacy, shall be placed in separate subparagraphs. If a design decision depends upon system states or modes, this dependency shall be indicated. Design conventions needed to understand the design shall be presented or referenced. Examples of system-wide design decisions are the following:
+
+a. Design decisions regarding inputs the system will accept and outputs it will produce, including interfaces with other systems, configuration items, and users (4.3.x of this DID identifies topics to be considered in this description). If part or all of this information is given in Interface Design Descriptions (IDDs), they may be referenced.
+
+b. Design decisions on system behavior in response to each input or condition, including actions the system will perform, response times and other performance characteristics, description of physical systems modeled, selected equations/algorithms/ rules, and handling of unallowed inputs or conditions.
+
+c. Design decisions on how system databases/data files will appear to the user (4.3.x of this DID identifies topics to be considered in this description). If part or all of this information is given in Database Design Descriptions (DBDDs), they may be referenced.
+
+d. Selected approach to meeting safety, security, and privacy requirements.
+
+e. Design and construction choices for hardware or hardware-software systems, such as physical size, color, shape, weight, materials, and markings.
+
+f. Other system-wide design decisions made in response to requirements, such as selected approach to providing required flexibility, availability, and maintainability.
+
+# 4. System architectural design.
+
+This section shall be divided into the following paragraphs to describe the system architectural design. If part or all of the design depends upon system states or modes, this dependency shall be indicated. If design information falls into more than one paragraph, it may be presented once and referenced from the other paragraphs. Design conventions needed to understand the design shall be presented or referenced.
+
+Note: For brevity, this section is written in terms of organizing a system directly into Hardware Configuration Items (HWCIs), Computer Software Configuration Items (CSCIs), and manual operations, but should be interpreted to cover organizing a system into subsystems, organizing a subsystem into HWCIs, CSCIs, and manual operations, or other variations as appropriate.
+
+## 4.1 System components.
+
+This paragraph shall:
+
+a. Identify the components of the system (HWCIs, CSCIs, and manual operations). Each component shall be assigned a project-unique identifier. Note: a database may be treated as a CSCI or as part of a CSCI.
+
+b. Show the static (such as "consists of") relationship(s) of the components. Multiple relationships may be presented, depending on the selected design methodology.
+
+c. State the purpose of each component and identify the system requirements and system-wide design decisions allocated to it. (Alternatively, the allocation of requirements may be provided in 5.a.)
+
+d. Identify each component's development status/type, if known (such as new development, existing component to be reused as is, existing design to be reused as is, existing design or component to be reengineered, component to be developed for reuse, component planned for Build N, etc.) For existing design or components, the description shall provide identifying information, such as name, version, documentation references, location, etc.
+
+e. For each computer system or other aggregate of computer hardware resources identified for use in the system, describe its computer hardware resources (such as processors, memory, input/output devices, auxiliary storage, and communications/ network equipment). Each description shall, as applicable, identify the configuration items that will use the resource, describe the allocation of resource utilization to each CSCI that will use the resource (for example, 20% of the resource's capacity allocated to CSCI 1, 30% to CSCI 2), describe the conditions under which utilization will be measured, and describe the characteristics of the resource:
+
+   1. Descriptions of computer processors shall include, as applicable, manufacturer name and model number, processor speed/capacity, identification of instruction set architecture, applicable compiler(s), word size (number of bits in each computer word), character set standard (such as ASCII, EBCDIC), and interrupt capabilities.
+   2. Descriptions of memory shall include, as applicable, manufacturer name and model number and memory size, type, speed, and configuration (such as 256K cache memory, 16MB RAM (4MB x 4)).
+   3. Descriptions of input/output devices shall include, as applicable, manufacturer name and model number, type of device, and device speed/capacity.
+   4. Descriptions of auxiliary storage shall include, as applicable, manufacturer name and model number, type of storage, amount of installed storage, and storage speed.
+   5. Descriptions of communications/network equipment, such as modems, network interface cards, hubs, gateways, cabling, high speed data lines, or aggregates of these or other components, shall include, as applicable, manufacturer name and model number, data transfer rates/capacities, network topologies, transmission techniques, and protocols used.
+   6. Each description shall also include, as applicable, growth capabilities, diagnostic capabilities, and any additional hardware capabilities relevant to the description.
+
+f. Present a specification tree for the system, that is, a diagram that identifies and shows the relationships among the planned specifications for the system components.
+
+## 4.2 Concept of execution.
+
+This paragraph shall describe the concept of execution among the system components. It shall include diagrams and descriptions showing the dynamic relationship of the components, that is, how they will interact during system operation, including, as applicable, flow of execution control, data flow, dynamically controlled sequencing, state transition diagrams, timing diagrams, priorities among components, handling of interrupts, timing/sequencing relationships, exception handling, concurrent execution, dynamic allocation/deallocation, dynamic creation/deletion of objects, processes, tasks, and other aspects of dynamic behavior.
+
+## 4.3 Interface design.
+
+This paragraph shall be divided into the following subparagraphs to describe the interface characteristics of the system components. It shall include both interfaces among the components and their interfaces with external entities such as other systems, configuration items, and users. Note: There is no requirement for these interfaces to be completely designed at this level; this paragraph is provided to allow the recording of interface design decisions made as part of system architectural design. If part or all of this information is contained in Interface Design Descriptions (IDDs) or elsewhere, these sources may be referenced.
+
+### 4.3.1 Interface identification and diagrams.
+
+This paragraph shall state the project-unique identifier assigned to each interface and shall identify the interfacing entities (systems, configuration items, users, etc.) by name, number, version, and documentation references, as applicable. The identification shall state which entities have fixed interface characteristics (and therefore impose interface requirements on interfacing entities) and which are being developed or modified (thus having interface requirements imposed on them). One or more interface diagrams shall be provided, as appropriate, to depict the interfaces.
+
+### 4.3.x (Project-unique identifier of interface).
+
+This paragraph (beginning with 4.3.2) shall identify an interface by project-unique identifier, shall briefly identify the interfacing entities, and shall be divided into subparagraphs as needed to describe the interface characteristics of one or both of the interfacing entities. If a given interfacing entity is not covered by this SSDD (for example, an external system) but its interface characteristics need to be mentioned to describe interfacing entities that are, these characteristics shall be stated as assumptions or as "When [the entity not covered] does this, [the entity that is covered] will ...." This paragraph may reference other documents (such as data dictionaries, standards for protocols, and standards for user interfaces) in place of stating the information here. The design description shall include the following, as applicable, presented in any order suited to the information to be provided, and shall note any differences in these characteristics from the point of view of the interfacing entities (such as different expectations about the size, frequency, or other characteristics of data elements):
+
+a. Priority assigned to the interface by the interfacing entity(ies)
+
+b. Type of interface (such as real-time data transfer, storage-and-retrieval of data, etc.) to be implemented
+
+c. Characteristics of individual data elements that the interfacing entity(ies) will provide, store, send, access, receive, etc., such as:
+
+   1. Names/identifiers
+      a. Project-unique identifier
+      b. Non-technical (natural-language) name
+      c. DoD standard data element name
+      d. Technical name (e.g., variable or field name in code or database)
+      e. Abbreviation or synonymous names
+   2. Data type (alphanumeric, integer, etc.)
+   3. Size and format (such as length and punctuation of a character string)
+   4. Units of measurement (such as meters, dollars, nanoseconds)
+   5. Range or enumeration of possible values (such as 0-99)
+   6. Accuracy (how correct) and precision (number of significant digits)
+   7. Priority, timing, frequency, volume, sequencing, and other constraints, such as whether the data element may be updated and whether business rules apply
+   8. Security and privacy constraints
+   9. Sources (setting/sending entities) and recipients (using/receiving entities)
+
+d. Characteristics of data element assemblies (records, messages, files, arrays, displays, reports, etc.) that the interfacing entity(ies) will provide, store, send, access, receive, etc., such as:
+
+   1. Names/identifiers
+      a. Project-unique identifier to be used for traceability
+      b. Non-technical (natural language) name
+      c. Technical name (e.g., record or data structure name in code or database)
+      d. Abbreviations or synonymous names
+   2. Data elements in the assembly and their structure (number, order, grouping)
+   3. Medium (such as disk) and structure of data elements/assemblies on the medium
+   4. Visual and auditory characteristics of displays and other outputs (such as colors, layouts, fonts, icons and other display elements, beeps, lights)
+   5. Relationships among assemblies, such as sorting/access characteristics
+   6. Priority, timing, frequency, volume, sequencing, and other constraints, such as whether the assembly may be updated and whether business rules apply
+   7. Security and privacy constraints
+   8. Sources (setting/sending entities) and recipients (using/receiving entities)
+
+e. Characteristics of communication methods that the interfacing entity(ies) will use for the interface, such as:
+
+   1. Project-unique identifier(s)
+   2. Communication links/bands/frequencies/media and their characteristics
+   3. Message formatting
+   4. Flow control (such as sequence numbering and buffer allocation)
+   5. Data transfer rate, whether periodic/aperiodic, and interval between transfers
+   6. Routing, addressing, and naming conventions
+   7. Transmission services, including priority and grade
+   8. Safety/security/privacy considerations, such as encryption, user authentication, compartmentalization, and auditing
+
+f. Characteristics of protocols that the interfacing entity(ies) will use for the interface, such as:
+
+   1. Project-unique identifier(s)
+   2. Priority/layer of the protocol
+   3. Packeting, including fragmentation and reassembly, routing, and addressing
+   4. Legality checks, error control, and recovery procedures
+   5. Synchronization, including connection establishment, maintenance, termination
+   6. Status, identification, and any other reporting features
+
+g. Other characteristics, such as physical compatibility of the interfacing entity(ies) (dimensions, tolerances, loads, voltages, plug compatibility, etc.)
+
+# 5. Requirements traceability.
+
+This paragraph shall contain:
+
+a. Traceability from each system component identified in this SSDD to the system requirements allocated to it. (Alternatively, this traceability may be provided in 4.1.)
+
+b. Traceability from each system requirement to the system components to which it is allocated.
+
+# 6. Notes.
+
+This section shall contain any general information that aids in understanding this document (e.g., background information, glossary, rationale). This section shall contain an alphabetical listing of all acronyms, abbreviations, and their meanings as used in this document and a list of any terms and definitions needed to understand this document.
+
+# A. Appendixes.
+
+Appendixes may be used to provide information published separately for convenience in document maintenance (e.g., charts, classified data). As applicable, each appendix shall be referenced in the main body of the document where the data would normally have been provided. Appendixes may be bound as separate documents for ease in handling. Appendixes shall be lettered alphabetically (A, B, etc.).

package/lib/mil498-templates/SSS.md

@@ -0,0 +1,225 @@
+# 1. Scope.
+
+This section shall be divided into the following paragraphs.
+
+## 1.1 Identification.
+
+This paragraph shall contain a full identification of the system to which this document applies, including, as applicable, identification number(s), title(s), abbreviation(s), version number(s), and release number(s).
+
+## 1.2 System overview.
+
+This paragraph shall briefly state the purpose of the system to which this document applies. It shall describe the general nature of the system; summarize the history of system development, operation, and maintenance; identify the project sponsor, acquirer, user, developer, and support agencies; identify current and planned operating sites; and list other relevant documents.
+
+## 1.3 Document overview.
+
+This paragraph shall summarize the purpose and contents of this document and shall describe any security or privacy considerations associated with its use.
+
+# 2. Referenced documents.
+
+This section shall list the number, title, revision, and date of all documents referenced in this specification. This section shall also identify the source for all documents not available through normal Government stocking activities.
+
+# 3. Requirements.
+
+This section shall be divided into the following paragraphs to specify the system requirements, that is, those characteristics of the system that are conditions for its acceptance. Each requirement shall be assigned a project-unique identifier to support testing and traceability and shall be stated in such a way that an objective test can be defined for it. Each requirement shall be annotated with associated qualification method(s) (see section 4) and, for subsystems, traceability to system requirements (see section 5.a), if not provided in those sections. The degree of detail to be provided shall be guided by the following rule: Include those characteristics of the system that are conditions for system acceptance; defer to design descriptions those characteristics that the acquirer is willing to leave up to the developer. If there are no requirements in a given paragraph, the paragraph shall so state. If a given requirement fits into more than one paragraph, it may be stated once and referenced from the other paragraphs.
+
+## 3.1 Required states and modes.
+
+If the system is required to operate in more than one state or mode having requirements distinct from other states or modes, this paragraph shall identify and define each state and mode. Examples of states and modes include: idle, ready, active, post-use analysis, training, degraded, emergency, backup, wartime, peacetime. The distinction between states and modes is arbitrary. A system may be described in terms of states only, modes only, states within modes, modes within states, or any other scheme that is useful. If no states or modes are required, this paragraph shall so state, without the need to create artificial distinctions. If states and/or modes are required, each requirement or group of requirements in this specification shall be correlated to the states and modes. The correlation may be indicated by a table or other method in this paragraph, in an appendix referenced from this paragraph, or by annotation of the requirements in the paragraphs where they appear.
+
+## 3.2 System capability requirements.
+
+This paragraph shall be divided into subparagraphs to itemize the requirements associated with each capability of the system. A "capability" is defined as a group of related requirements. The word "capability" may be replaced with "function," "subject," "object," or other term useful for presenting the requirements.
+
+### 3.2.x (System capability).
+
+This paragraph shall identify a required system capability and shall itemize the requirements associated with the capability. If the capability can be more clearly specified by dividing it into constituent capabilities, the constituent capabilities shall be specified in subparagraphs. The requirements shall specify required behavior of the system and shall include applicable parameters, such as response times, throughput times, other timing constraints, sequencing, accuracy, capacities (how much/how many), priorities, continuous operation requirements, and allowable deviations based on operating conditions. The requirements shall include, as applicable, required behavior under unexpected, unallowed, or "out of bounds" conditions, requirements for error handling, and any provisions to be incorporated into the system to provide continuity of operations in the event of emergencies. Paragraph 3.3.x of this DID provides a list of topics to be considered when specifying requirements regarding inputs the system must accept and outputs it must produce.
+
+## 3.3 System external interface requirements.
+
+This paragraph shall be divided into subparagraphs to specify the requirements, if any, for the system's external interfaces. This paragraph may reference one or more Interface Requirements Specifications (IRSs) or other documents containing these requirements.
+
+### 3.3.1 Interface identification and diagrams.
+
+This paragraph shall identify the required external interfaces of the system. The identification of each interface shall include a project-unique identifier and shall designate the interfacing entities (systems, configuration items, users, etc.) by name, number, version, and documentation references, as applicable. The identification shall state which entities have fixed interface characteristics (and therefore impose interface requirements on interfacing entities) and which are being developed or modified (thus having interface requirements imposed on them). One or more interface diagrams shall be provided to depict the interfaces.
+
+### 3.3.x (Project-unique identifier of interface).
+
+This paragraph (beginning with 3.3.2) shall identify a system external interface by project-unique identifier, shall briefly identify the interfacing entities, and shall be divided into subparagraphs as needed to state the requirements imposed on the system to achieve the interface. Interface characteristics of the other entities involved in the interface shall be stated as assumptions or as "When [the entity not covered] does this, the system shall...," not as requirements on the other entities. This paragraph may reference other documents (such as data dictionaries, standards for communication protocols, and standards for user interfaces) in place of stating the information here. The requirements shall include the following, as applicable, presented in any order suited to the requirements, and shall note any differences in these characteristics from the point of view of the interfacing entities (such as different expectations about the size, frequency, or other characteristics of data elements):
+
+a. Priority that the system must assign the interface
+
+b. Requirements on the type of interface (such as real-time data transfer, storage-and-retrieval of data, etc.) to be implemented
+
+c. Required characteristics of individual data elements that the system must provide, store, send, access, receive, etc., such as:
+
+   1. Names/identifiers
+      a. Project-unique identifier
+      b. Non-technical (natural-language) name
+      c. DoD standard data element name
+      d. Technical name (e.g., variable or field name in code or database)
+      e. Abbreviation or synonymous names
+   2. Data type (alphanumeric, integer, etc.)
+   3. Size and format (such as length and punctuation of a character string)
+   4. Units of measurement (such as meters, dollars, nanoseconds)
+   5. Range or enumeration of possible values (such as 0-99)
+   6. Accuracy (how correct) and precision (number of significant digits)
+   7. Priority, timing, frequency, volume, sequencing, and other constraints, such as whether the data element may be updated and whether business rules apply
+   8. Security and privacy constraints
+   9. Sources (setting/sending entities) and recipients (using/receiving entities)
+
+d. Required characteristics of data element assemblies (records, messages, files, arrays, displays, reports, etc.) that the system must provide, store, send, access, receive, etc., such as:
+
+   1. Names/identifiers
+      a. Project-unique identifier
+      b. Non-technical (natural language) name
+      c. Technical name (e.g., record or data structure name in code or database)
+      d. Abbreviations or synonymous names
+   2. Data elements in the assembly and their structure (number, order, grouping)
+   3. Medium (such as disk) and structure of data elements/assemblies on the medium
+   4. Visual and auditory characteristics of displays and other outputs (such as colors, layouts, fonts, icons and other display elements, beeps, lights)
+   5. Relationships among assemblies, such as sorting/access characteristics
+   6. Priority, timing, frequency, volume, sequencing, and other constraints, such as whether the assembly may be updated and whether business rules apply
+   7. Security and privacy constraints
+   8. Sources (setting/sending entities) and recipients (using/receiving entities)
+
+e. Required characteristics of communication methods that the system must use for the interface, such as:
+
+   1. Project-unique identifier(s)
+   2. Communication links/bands/frequencies/media and their characteristics
+   3. Message formatting
+   4. Flow control (such as sequence numbering and buffer allocation)
+   5. Data transfer rate, whether periodic/aperiodic, and interval between transfers
+   6. Routing, addressing, and naming conventions
+   7. Transmission services, including priority and grade
+   8. Safety/security/privacy considerations, such as encryption, user authentication, compartmentalization, and auditing
+
+f. Required characteristics of protocols the system must use for the interface, such as:
+
+   1. Project-unique identifier(s)
+   2. Priority/layer of the protocol
+   3. Packeting, including fragmentation and reassembly, routing, and addressing
+   4. Legality checks, error control, and recovery procedures
+   5. Synchronization, including connection establishment, maintenance, termination
+   6. Status, identification, and any other reporting features
+
+g. Other required characteristics, such as physical compatibility of the interfacing entities (dimensions, tolerances, loads, plug compatibility, etc.), voltages, etc.
+
+## 3.4 System internal interface requirements.
+
+This paragraph shall specify the requirements, if any, imposed on interfaces internal to the system. If all internal interfaces are left to the design or to requirement specifications for system components, this fact shall be so stated. If such requirements are to be imposed, paragraph 3.3 of this DID provides a list of topics to be considered.
+
+## 3.5 System internal data requirements.
+
+This paragraph shall specify the requirements, if any, imposed on data internal to the system. Included shall be requirements, if any, on databases and data files to be included in the system. If all decisions about internal data are left to the design or to requirements specifications for system components, this fact shall be so stated. If such requirements are to be imposed, paragraphs 3.3.x.c and 3.3.x.d of this DID provide a list of topics to be considered.
+
+## 3.6 Adaptation requirements.
+
+This paragraph shall specify the requirements, if any, concerning installation-dependent data that the system is required to provide (such as site-dependent latitude and longitude or site-dependent state tax codes) and operational parameters that the system is required to use that may vary according to operational needs (such as parameters indicating operation-dependent targeting constants or data recording).
+
+## 3.7 Safety requirements.
+
+This paragraph shall specify the system requirements, if any, concerned with preventing or minimizing unintended hazards to personnel, property, and the physical environment. Examples include restricting the use of dangerous materials; classifying explosives for purposes of shipping, handling, and storing; abort/escape provisions from enclosures; gas detection and warning devices; grounding of electrical systems; decontamination; and explosion proofing. This paragraph shall include the system requirements, if any, for nuclear components, including, as applicable, requirements for component design, prevention of inadvertent detonation, and compliance with nuclear safety rules.
+
+## 3.8 Security and privacy requirements.
+
+This paragraph shall specify the system requirements, if any, concerned with maintaining security and privacy. The requirements shall include, as applicable, the security/privacy environment in which the system must operate, the type and degree of security or privacy to be provided, the security/privacy risks the system must withstand, required safeguards to reduce those risks, the security/privacy policy that must be met, the security/privacy accountability the system must provide, and the criteria that must be met for security/privacy certification/accreditation.
+
+## 3.9 System environment requirements.
+
+This paragraph shall specify the requirements, if any, regarding the environment in which the system must operate. Examples for a software system are the computer hardware and operating system on which the software must run. (Additional requirements concerning computer resources are given in the next paragraph). Examples for a hardware-software system include the environmental conditions that the system must withstand during transportation, storage, and operation, such as conditions in the natural environment (wind, rain, temperature, geographic location), the induced environment (motion, shock, noise, electromagnetic radiation), and environments due to enemy action (explosions, radiation).
+
+## 3.10 Computer resource requirements.
+
+This paragraph shall be divided into the following subparagraphs. Depending upon the nature of the system, the computer resources covered in these subparagraphs may constitute the environment of the system (as for a software system) or components of the system (as for a hardware-software system).
+
+### 3.10.1 Computer hardware requirements.
+
+This paragraph shall specify the requirements, if any, regarding computer hardware that must be used by, or incorporated into, the system. The requirements shall include, as applicable, number of each type of equipment, type, size, capacity, and other required characteristics of processors, memory, input/output devices, auxiliary storage, communications/network equipment, and other required equipment.
+
+### 3.10.2 Computer hardware resource utilization requirements.
+
+This paragraph shall specify the requirements, if any, on the system's computer hardware resource utilization, such as maximum allowable use of processor capacity, memory capacity, input/output device capacity, auxiliary storage device capacity, and communications/network equipment capacity. The requirements (stated, for example, as percentages of the capacity of each computer hardware resource) shall include the conditions, if any, under which the resource utilization is to be measured.
+
+### 3.10.3 Computer software requirements.
+
+This paragraph shall specify the requirements, if any, regarding computer software that must be used by, or incorporated into, the system. Examples include operating systems, database management systems, communications/ network software, utility software, input and equipment simulators, test software, and manufacturing software. The correct nomenclature, version, and documentation references of each such software item shall be provided.
+
+### 3.10.4 Computer communications requirements.
+
+This paragraph shall specify the additional requirements, if any, concerning the computer communications that must be used by, or incorporated into, the system. Examples include geographic locations to be linked; configuration and network topology; transmission techniques; data transfer rates; gateways; required system use times; type and volume of data to be transmitted/received; time boundaries for transmission/reception/response; peak volumes of data; and diagnostic features.
+
+## 3.11 System quality factors.
+
+This paragraph shall specify the requirements, if any, pertaining to system quality factors. Examples include quantitative requirements concerning system functionality (the ability to perform all required functions), reliability (the ability to perform with correct, consistent results -- such as mean time between failure for equipment), maintainability (the ability to be easily serviced, repaired, or corrected), availability (the ability to be accessed and operated when needed), flexibility (the ability to be easily adapted to changing requirements), portability of software (the ability to be easily modified for a new environment), reusability (the ability to be used in multiple applications), testability (the ability to be easily and thoroughly tested), usability (the ability to be easily learned and used), and other attributes.
+
+## 3.12 Design and construction constraints.
+
+This paragraph shall specify the requirements, if any, that constrain the design and construction of the system. For hardware-software systems, this paragraph shall include the physical requirements imposed on the system. These requirements may be specified by reference to appropriate commercial or military standards and specifications. Examples include requirements concerning:
+
+a. Use of a particular system architecture or requirements on the architecture, such as required subsystems; use of standard, military, or existing components; or use of Government/acquirer-furnished property (equipment, information, or software)
+
+b. Use of particular design or construction standards; use of particular data standards; use of a particular programming language; workmanship requirements and production techniques
+
+c. Physical characteristics of the system (such as weight limits, dimensional limits, color, protective coatings); interchangeability of parts; ability to be transported from one location to another; ability to be carried or set up by one, or a given number of, persons
+
+d. Materials that can and cannot be used; requirements on the handling of toxic materials; limits on the electromagnetic radiation that the system is permitted to generate
+
+e. Use of nameplates, part marking, serial and lot number marking, and other identifying markings
+
+f. Flexibility and expandability that must be provided to support anticipated areas of growth or changes in technology, threat, or mission
+
+## 3.13 Personnel-related requirements.
+
+This paragraph shall specify the system requirements, if any, included to accommodate the number, skill levels, duty cycles, training needs, or other information about the personnel who will use or support the system. Examples include requirements for the number of work stations to be provided and for built-in help and training features. Also included shall be the human factors engineering requirements, if any, imposed on the system. These requirements shall include, as applicable, considerations for the capabilities and limitations of humans, foreseeable human errors under both normal and extreme conditions, and specific areas where the effects of human error would be particularly serious. Examples include requirements for adjustable-height work stations, color and duration of error messages, physical placement of critical indicators or buttons, and use of auditory signals.
+
+## 3.14 Training-related requirements.
+
+This paragraph shall specify the system requirements, if any, pertaining to training. Examples include training devices and training materials to be included in the system.
+
+## 3.15 Logistics-related requirements.
+
+This paragraph shall specify the system requirements, if any, concerned with logistics considerations. These considerations may include: system maintenance, software support, system transportation modes, supply-system requirements, impact on existing facilities, and impact on existing equipment.
+
+## 3.16 Other requirements.
+
+This paragraph shall specify additional system requirements, if any, not covered in the previous paragraphs. Examples include requirements for system documentation, such as specifications, drawings, technical manuals, test plans and procedures, and installation instruction data, if not covered in other contractual documents.
+
+## 3.17 Packaging requirements.
+
+This section shall specify the requirements, if any, for packaging, labeling, and handling the system and its components for delivery. Applicable military specifications and standards may be referenced if appropriate.
+
+## 3.18 Precedence and criticality of requirements.
+
+This paragraph shall specify, if applicable, the order of precedence, criticality, or assigned weights indicating the relative importance of the requirements in this specification. Examples include identifying those requirements deemed critical to safety, to security, or to privacy for purposes of singling them out for special treatment. If all requirements have equal weight, this paragraph shall so state.
+
+# 4. Qualification provisions.
+
+This section shall define a set of qualification methods and shall specify for each requirement in Section 3 the method(s) to be used to ensure that the requirement has been met. A table may be used to present this information, or each requirement in Section 3 may be annotated with the method(s) to be used. Qualification methods may include:
+
+a. Demonstration: The operation of the system, or a part of the system, that relies on observable functional operation not requiring the use of instrumentation, special test equipment, or subsequent analysis.
+
+b. Test: The operation of the system, or a part of the system, using instrumentation or other special test equipment to collect data for later analysis.
+
+c. Analysis: The processing of accumulated data obtained from other qualification methods. Examples are reduction, interpolation, or extrapolation of test results.
+
+d. Inspection: The visual examination of system components, documentation, etc.
+
+e. Special qualification methods. Any special qualification methods for the system, such as special tools, techniques, procedures, facilities, acceptance limits, use of standard samples, preproduction or periodic production samples, pilot models, or pilot lots.
+
+# 5. Requirements traceability.
+
+For system-level specifications, this paragraph does not apply. For subsystem-level specifications, this paragraph shall contain:
+
+a. Traceability from each subsystem requirement in this specification to the system requirements it addresses. (Alternatively, this traceability may be provided by annotating each requirement in Section 3.)
+
+   Note: Each level of system refinement may result in requirements not directly traceable to higher-level requirements. For example, a system architectural design that creates two subsystems may result in requirements about how the subsystems will interface, even though these interfaces are not covered in system requirements. Such requirements may be traced to a general requirement such as "system implementation" or to the system design decisions that resulted in their generation.
+
+b. Traceability from each system requirement that has been allocated to the subsystem covered by this specification to the subsystem requirements that address it. All system requirements allocated to the subsystem shall be accounted for. Those that trace to subsystem requirements contained in Interface Requirements Specifications (IRSs) shall reference those IRSs.
+
+# 6. Notes.
+
+This section shall contain any general information that aids in understanding this document (e.g., background information, glossary, rationale). This section shall contain an alphabetical listing of all acronyms, abbreviations, and their meanings as used in this document and a list of any terms and definitions needed to understand this document.
+
+# A. Appendixes.
+
+Appendixes may be used to provide information published separately for convenience in document maintenance (e.g., charts, classified data). As applicable, each appendix shall be referenced in the main body of the document where the data would normally have been provided. Appendixes may be bound as separate documents for ease in handling. Appendixes shall be lettered alphabetically (A, B, etc.).

package/lib/mil498-templates/STD.md

@@ -0,0 +1,188 @@
+# 1. Scope.
+
+This section shall be divided into the following paragraphs.
+
+## 1.1 Identification.
+
+This paragraph shall contain a full identification of the system and the software to which this document applies, including, as applicable, identification number(s), title(s), abbreviation(s), version number(s), and release number(s).
+
+## 1.2 System overview.
+
+This paragraph shall briefly state the purpose of the system and the software to which this document applies. It shall describe the general nature of the system and software; summarize the history of system development, operation, and maintenance; identify the project sponsor, acquirer, user, developer, and support agencies; identify current and planned operating sites; and list other relevant documents.
+
+## 1.3 Document overview.
+
+This paragraph shall summarize the purpose and contents of this document and shall describe any security or privacy considerations associated with its use.
+
+# 2. Referenced documents.
+
+This section shall list the number, title, revision, and date of all documents referenced in this document. This section shall also identify the source for all documents not available through normal Government stocking activities.
+
+# 3. Test preparations.
+
+This section shall be divided into the following paragraphs. Safety precautions, marked by WARNING or CAUTION, and security and privacy considerations shall be included as applicable.
+
+## 3.x (Project-unique identifier of a test).
+
+This paragraph shall identify a test by project-unique identifier, shall provide a brief description, and shall be divided into the following subparagraphs. When the information required duplicates information previously specified for another test, that information may be referenced rather than repeated.
+
+### 3.x.1 Hardware preparation.
+
+This paragraph shall describe the procedures necessary to prepare the hardware for the test. Reference may be made to published operating manuals for these procedures. The following shall be provided, as applicable:
+
+a. The specific hardware to be used, identified by name and, if applicable, number
+
+b. Any switch settings and cabling necessary to connect the hardware
+
+c. One or more diagrams to show hardware, interconnecting control, and data paths
+
+d. Step-by-step instructions for placing the hardware in a state of readiness
+
+### 3.x.2 Software preparation.
+
+This paragraph shall describe the procedures necessary to prepare the item(s) under test and any related software, including data, for the test. Reference may be made to published software manuals for these procedures. The following information shall be provided, as applicable:
+
+a. The specific software to be used in the test
+
+b. The storage medium of the item(s) under test (e.g., magnetic tape, diskette)
+
+c. The storage medium of any related software (e.g., simulators, test drivers, databases)
+
+d. Instructions for loading the software, including required sequence
+
+e. Instructions for software initialization common to more than one test case
+
+### 3.x.3 Other pre-test preparations.
+
+This paragraph shall describe any other pre-test personnel actions, preparations, or procedures necessary to perform the test.
+
+# 4. Test descriptions.
+
+This section shall be divided into the following paragraphs. Safety precautions, marked by WARNING or CAUTION, and security and privacy considerations shall be included as applicable.
+
+## 4.x (Project-unique identifier of a test).
+
+This paragraph shall identify a test by project-unique identifier and shall be divided into the following subparagraphs. When the required information duplicates information previously provided, that information may be referenced rather than repeated.
+
+### 4.x.y (Project-unique identifier of a test case).
+
+This paragraph shall identify a test case by project-unique identifier, state its purpose, and provide a brief description. The following subparagraphs shall provide a detailed description of the test case.
+
+#### 4.x.y.1 Requirements addressed.
+
+This paragraph shall identify the CSCI or system requirements addressed by the test case. (Alternatively, this information may be provided in 5.a.)
+
+#### 4.x.y.2 Prerequisite conditions.
+
+This paragraph shall identify any prerequisite conditions that must be established prior to performing the test case. The following considerations shall be discussed, as applicable:
+
+a. Hardware and software configuration
+
+b. Flags, initial breakpoints, pointers, control parameters, or initial data to be set/reset prior to test commencement
+
+c. Preset hardware conditions or electrical states necessary to run the test case
+
+d. Initial conditions to be used in making timing measurements
+
+e. Conditioning of the simulated environment
+
+f. Other special conditions peculiar to the test case
+
+#### 4.x.y.3 Test inputs.
+
+This paragraph shall describe the test inputs necessary for the test case. The following shall be provided, as applicable:
+
+a. Name, purpose, and description (e.g., range of values, accuracy) of each test input
+
+b. Source of the test input and the method to be used for selecting the test input
+
+c. Whether the test input is real or simulated
+
+d. Time or event sequence of test input
+
+e. The manner in which the input data will be controlled to:
+
+   1. Test the item(s) with a minimum/reasonable number of data types and values
+   2. Exercise the item(s) with a range of valid data types and values that test for overload, saturation, and other "worst case" effects
+   3. Exercise the item(s) with invalid data types and values to test for appropriate handling of irregular inputs
+   4. Permit retesting, if necessary
+
+#### 4.x.y.4 Expected test results.
+
+This paragraph shall identify all expected test results for the test case. Both intermediate and final test results shall be provided, as applicable.
+
+#### 4.x.y.5 Criteria for evaluating results.
+
+This paragraph shall identify the criteria to be used for evaluating the intermediate and final results of the test case. For each test result, the following information shall be provided, as applicable:
+
+a. The range or accuracy over which an output can vary and still be acceptable
+
+b. Minimum number of combinations or alternatives of input and output conditions that constitute an acceptable test result
+
+c. Maximum/minimum allowable test duration, in terms of time or number of events
+
+d. Maximum number of interrupts, halts, or other system breaks that may occur
+
+e. Allowable severity of processing errors
+
+f. Conditions under which the result is inconclusive and re-testing is to be performed
+
+g. Conditions under which the outputs are to be interpreted as indicating irregularities in input test data, in the test database/data files, or in test procedures
+
+h. Allowable indications of the control, status, and results of the test and the readiness for the next test case (may be output of auxiliary test software)
+
+i. Additional criteria not mentioned above.
+
+#### 4.x.y.6 Test procedure.
+
+This paragraph shall define the test procedure for the test case. The test procedure shall be defined as a series of individually numbered steps listed sequentially in the order in which the steps are to be performed. For convenience in document maintenance, the test procedures may be included as an appendix and referenced in this paragraph. The appropriate level of detail in each test procedure depends on the type of software being tested. For some software, each keystroke may be a separate test procedure step; for most software, each step may include a logically related series of keystrokes or other actions. The appropriate level of detail is the level at which it is useful to specify expected results and compare them to actual results. The following shall be provided for each test procedure, as applicable:
+
+a. Test operator actions and equipment operation required for each step, including commands, as applicable, to:
+
+   1. Initiate the test case and apply test inputs
+   2. Inspect test conditions
+   3. Perform interim evaluations of test results
+   4. Record data
+   5. Halt or interrupt the test case
+   6. Request data dumps or other aids, if needed
+   7. Modify the database/data files
+   8. Repeat the test case if unsuccessful
+   9. Apply alternate modes as required by the test case
+   10. Terminate the test case
+
+b. Expected result and evaluation criteria for each step
+
+c. If the test case addresses multiple requirements, identification of which test procedure step(s) address which requirements. (Alternatively, this information may be provided in 5.)
+
+d. Actions to follow in the event of a program stop or indicated error, such as:
+
+   1. Recording of critical data from indicators for reference purposes
+   2. Halting or pausing time-sensitive test-support software and test apparatus
+   3. Collection of system and operator records of test results
+
+e. Procedures to be used to reduce and analyze test results to accomplish the following, as applicable:
+
+   1. Detect whether an output has been produced
+   2. Identify media and location of data produced by the test case
+   3. Evaluate output as a basis for continuation of test sequence
+   4. Evaluate test output against required output
+
+#### 4.x.y.7 Assumptions and constraints.
+
+This paragraph shall identify any assumptions made and constraints or limitations imposed in the description of the test case due to system or test conditions, such as limitations on timing, interfaces, equipment, personnel, and database/data files. If waivers or exceptions to specified limits and parameters are approved, they shall be identified and this paragraph shall address their effects and impacts upon the test case.
+
+# 5. Requirements traceability.
+
+This paragraph shall contain:
+
+a. Traceability from each test case in this STD to the system or CSCI requirements it addresses. If a test case addresses multiple requirements, traceability from each set of test procedure steps to the requirement(s) addressed. (Alternatively, this traceability may be provided in 4.x.y.1.)
+
+b. Traceability from each system or CSCI requirement covered by this STD to the test case(s) that address it. For CSCI testing, traceability from each CSCI requirement in the CSCI's Software Requirements Specification (SRS) and associated Interface Requirements Specifications (IRSs). For system testing, traceability from each system requirement in the system's System/Subsystem Specification (SSS) and associated IRSs. If a test case addresses multiple requirements, the traceability shall indicate the particular test procedure steps that address each requirement.
+
+# 6. Notes.
+
+This section shall contain any general information that aids in understanding this document (e.g., background information, glossary, rationale). This section shall include an alphabetical listing of all acronyms, abbreviations, and their meanings as used in this document and a list of any terms and definitions needed to understand this document.
+
+# A. Appendixes.
+
+Appendixes may be used to provide information published separately for convenience in document maintenance (e.g., charts, classified data). As applicable, each appendix shall be referenced in the main body of the document where the data would normally have been provided. Appendixes may be bound as separate documents for ease in handling. Appendixes shall be lettered alphabetically (A, B, etc.).