Ministry of Agriculture & Lands
SDLC STANDARDS
<Overview
| Architecture & Environment | Development Standard>
<Mandatory
| Recommended | Optional>
This document is a template for developing IMB SDLC standards. It uses the following typographic conventions:
- Text in sanserif type should be included "as is" in the standard.
- Angle brackets <> indicates variable text to be supplied by the author of the standard. Variables separated by a vertical bars | are alternative choices.
- Text in italic Roman type (like this paragraph) are explanatory comments, not to be included in the standard.
Label the standard as Mandatory, Recommended, or Optional.
- Mandatory standards are enforced by Ministry, unless a specific exemption has been allowed.
- Recommended standards are expected to be applied in typical cases, but may be relaxed depending on the circumstances.
- Optional standards are entirely at the discretion of the vendor.
Within a mandatory or recommended standard,
certain parts may be less strict than the overall standard
(e.g., parts of a mandatory standard may be recommended
or optional). Such departures are indicated by appropriate
language (see Standards Development Methodology, section
10.3 Writing Guidelines).
<STANDARDS NAME>
Version XX.X <Date Updated>
This document contains the published standards for the Ministry's approach to <Standards Name>.
Please any refer and comments, corrections, or updates to the <Standards Coordinator>. (Ensure the email link is up to date)
| APPENDICES |
||
| Appendix
A: <Appendix
Name> Appendix B: <Appendix Name> |
||
This section of the document records the various versions or releases of this document.
| Version | Details/Description | Distribution | Date | Author | Organization |
| 0.1 | First Draft | Whole Document | <date> | <Author> | <Organization> |
| 0.2 | Second Draft | Whole Document | <date> | <Author> | <Organization> |
| 0.3 | Third Draft | Whole Document | <date> | <Author> | <Organization> |
| 1.0 | Published to Web | Whole Document | <date> | <Author> | <Organization> |
| 1.1 | Updated | Whole Document | <date> | <Author> | <Organization> |
| Table 1: Version Control |
1. INTRODUCTION
State the name of the standard, plus a brief description to clarify any ambiguity. State the type (overview, architecture and environment, or development) and status (mandatory or non-mandatory) of the standard.
1.1 Purpose
State the objectives of the standard (e.g. to provide introduction only, or to provide in-depth detail) and the key concepts that the reader should grasp after reading the document.
1.2 Audience
Identify the primary audiences and secondary audiences. The content should be targeted at the primary audience with some consideration given to the secondary audiences (e.g., brief explanations of unfamiliar concepts). However, secondary audiences need not fully understand or make use of the standard in its entirety.
Quite often the primary target audience are the groups that need to implement the standard (i.e. vendor developing the application) and the secondary audience are groups that need to assure the completeness of this implementation (i.e. IMB Business Analyst or Application Manager).
Audiences may be identified in terms of their project roles or disciplines (e.g., PM, QA, Analysis, Design) and in terms of their relation to the Ministry (e.g., internal staff, external vendor).
1.3 Scope/Exclusions
Define the scope of the standard, ideally, the coverage required to make the standard comprehensible and useful to the target audiences. List functional areas and tasks that may be impacted by the standard. (The functional areas may be a subset of the primary audience identified in section 1.2. The Scope/Exclusions section should describe briefly how the standard affects these groups.)
The scope definition should define both in-scope elements and out-of-scope elements (exclusions). Exclusions may be defined to minimize overlap with related standards or to set an appropriate level of descriptive detail.
1.4 Assumptions
Identify all constraints, dependencies, issues, and other assumptions that may assist the audience in interpreting or applying the standard. Identify the likely impacts of changes in these assumptions.
1.5 Other Standards
Reference other specific standards that may assist the audience in interpreting or applying the standard. Do not simply reference the standards repository, unless you are sure that all the standards there apply equally to the current standard.
2. <STANDARD DESCRIPTION/TITLE>
This is the beginning of the standard-specific content. The body of the standard consists of one or more chapters, depending on the length and complexity of the standard. For guidelines on decomposing the content of a standard, see Standards Development Methodology, section 10.1 Document Structure ).
< Provide the paragraphs details.>
< Provide the paragraphs details.>
< Provide the paragraphs details.>
< Provide the paragraphs details.>
3. <STANDARD DESCRIPTION/TITLE>
<Next section, if required. Repeat as necessary remembering to renumber sections appropriately.>
< Provide the paragraphs details.>
< Provide the paragraphs details.>
< Provide the paragraphs details.>
< Provide the paragraphs details.>
4. CONCLUSION
This section should summarize the standard and its uses. It may be a condensed version of text from elsewhere in the document.
Appendices should contain material that is relevant to the standard but would interrupt the flow of the document.
<Content>
