Develop Software Documentation Development Lifecycle (SDDL)
Standard Operation Procedure (SOP)
LOCATION: Victor 12 Inc.
SITUATION:
Victor 12 is a Service-Disabled Veteran-Owned Small Business (SDVOSB) specializing in training and IT solutions, including instructor-led training, e-learning, and managed services. In providing maintenance for Learning Management System software and related software products, Victor 12 needed a method to develop, publish, and maintain related user software documents while providing repeatable system-level quality. Prior to this initiative, processes were ad-hoc and inconsistent, with no documented lifecycle.
NEEDS DEFINITION:
A Software Documentation Development Lifecycle (SDDL) Quality System-Level Process Standard Operating Procedure (SOP) was needed to ensure consistency, efficiency, and quality in the process of creating and maintaining end-user software documentation, framed within ISO 9001:2015 concepts and incorporating requirements for VA Documentation Style Guide and Section 508 Accessibility compliance.
Reference: www.iso.org/files/live/sites/isoorg/files/archive/pdf/en/documented_information.pdf (www.iso.org, ISO 9001:2015, Edition 5, 2015)
SOLUTION DEVELOPMENT:
Standardized SDDL Workflow: A 6-Phase SDDL workflow was developed with swimlane diagrams defining roles and responsibilities for technical writers, subject matter experts, quality assurance reviewers, and stakeholder approvers. This established the first defined, repeatable methodology for documentation creation and maintenance.
Template Compliance Management: Victor 12 provided baseline VBA LMS templates, but conflicts emerged between template constraints and quality standards (ISO 9001:2015, VA Documentation Style Guide, Section 508 Accessibility). Each conflict was analyzed, solutions were recommended, and template adjustments were implemented to maintain compliance while preserving usability.
Quality Checkpoints and Measurable Standards: Verification checklists, content block standards, and document review cycles were established to ensure consistency across all outputs, demonstrating customer focus through documented work instructions and measurable quality markers.
Results: The implemented system produced improvements in document architecture, content block consistency, navigation clarity, and software screen image integration. Client feedback indicated increased satisfaction with overall document usability and accessibility.