EPG

ENGINEERING PROCESS GUIDE

Search the EPG  
 

Systems Engineering and Project Documentation

 

 

    Project documentation:

    At the conclusion of a project, the records and documentation should be archived for future reference. Typical project documentation and guidance of when they are needed can be found in the table below.

    • Documents that require management and revision control should be released in the Document Control Center (DCC).
    • Engineering calculations, analyses, and simulations are records.
    • Typical project documentation are kept as records and documents.
    • The engineering policy and guideline for Document Controls can be found here

     

    Engineering Systems   
      Low Formality Medium Formality High Formality (externally driven requirements apply)
    Project Execution Plan not required not required Project Execution Plan and project management are defined by agency, customer…
    Project Plan (PP) PP – informal:  email OK, meeting with minutes, PP encouraged, documented  in controlled project repository (such as Windchill) PP required - approved by host division, filed in repository (such as Windchill or DCC) Formal See Project Execution Plan
    Project Requirements Documents (PRD) /Scope Document/Statement Of Work (SOW) informal, email OK scope document is part of the PP, verified at project closure, Acceptance Criteria/ Project Completion Criteria are defined in PP Formal: System Requirements Documents, Technical requirements and specified, tracked, and verified
    Interface definition and documentation informal, email OK, part of the kick-off meeting and PP stakeholders and interfaces defined in the PP, documented in project repository Formal: Interface Control Documents, tracked and verified 
    Grade Assessment (GA) GA –   documented  in controlled project repository (such as Windchill) GA – documented in PP GA – formal, done by PM
    Project Kick-off encouraged, slides or meeting minutes documented  in controlled project repository (such as Windchill) required   - presentation and action items filed in project repository (such as Windchill) required
    Project Schedule excel spread sheet or similar tool, email ok, documented in project repository,  project schedule developed milestones, project schedule updates and tracking, documented in project repository, project office support as needed WBS developed, WBS dictionary, project tracking required, EVMS as defined in the project execution plan
    WBS (Work Breakdown Structure) dictionary not required optional required, documented in project repository
    Cost Estimate (CE) CE/Summary - informal, documented in email, project plan or presentation,  documented  in controlled project repository (such as Windchill) CE/Summary - high level estimate, part of the PP CE  – detailed done by PM, approved by customer or customer division
    Project Design, Fabrication, Installation Meetings  encouraged regular meeting required, informal meeting notes regular meeting required, meeting notes on document server
    Configuration Control  encouraged Engineering Change Note (ECN) list (e.g. excel) encouraged, change log (as built) encouraged, additional documentation optional, documented in project repository Change Control Board, process is formally defined in the project execution plan
    Project Documentation establish project repository (such as windchill) for project documents (requirements, interfaces, schedules, budgets…) establish project repository (such as windchill) for project documents (requirements, interfaces, schedules, budgets…) Project Repository and configuration management required
    Quality Assurance QA - support as needed (TBD by PM) QA - support as needed (TBD by PM) QA - required, might be tailored to the project 

    DOCUMENT INFORMATION

    Title:

    Project Documentation Requirements

    Document number

     

    Revision number

    1

    Publication date:

    7/15/2015

    Effective date:

    7/15/2015

    Next review date:

    9/25/2015

    Last Edited By:

    dleitner@lbl.gov

    EPG Section (home)

    Conduct of Engineering

    EPG Section (cross-reference)

     

    Functional Division

    Engineering

     

     

     

     

     

     

     

     

     

    • No labels

    Adaptavist ThemeBuilder EngineAtlassian Confluence