CHANWOO
SONG 한국어 ↗
← All work
AUTOMATION / TRACEABILITY2025

Automotive
Documentation

Document generation with traceable engineering changes.

CUSTOMER PROJECT / SOLUTION DESIGN

Case study by

Traceability review screen design · relationships and change impact
Traceability review screen design · relationships and change impact
01 / CONTEXT & CONTRIBUTION

The problem.
My part in it.

Background

  • Documentation spanned requirements, design, code and tests.
  • Changes required a way to identify affected artifacts.
  • Generated documents also needed links to source and tests.
  • The design had to fit on-premises, Git and Markdown workflows.

Objective

  • Make document creation and change review repeatable.
  • Propose generation, traceability and expert review as one flow.

My role

  • Defined requirements, operating scenarios and module boundaries.
  • Scoped functions, deliverables and the implementation roadmap.
02 / SYSTEM DESIGN

How it connects.

Proposed architecture
Document generation & engineering traceabilityProposed system · on-premise processing, expert review and Git-managed artifactsDocument generation & engineering traceabilityProposed system · on-premise processing, expert review and Git-managed artifactsCUSTOMER ON-PREMISE ENVIRONMENTInput change → updateRequirementsRequirementsDesignDesignSource codeSource codeTestsTestsDocument generation — Parse inputs → structure → generate / Markdown deliverablesDocument generationParse inputs → structure → generateMarkdown deliverablesTraceability management — Requirement / code / document / test links / Review change impact and missing linksTraceability managementRequirement / code / document / test linksReview change impact and missing linksExpert review — Check content and relationshipsExpert reviewCheck content and relationshipsGit repository — Reviewed documents and linksGit repositoryReviewed documents and links
Zoom for detail
Processing / data flowIteration / feedbackService / environment boundary
01

Generation and traceability.

Generating a document does not maintain its relationship to requirements, code and tests. Define separate modules, with expert review linking their outputs.

02

Designed for the operating environment.

Use the customer’s on-premise, Git and Markdown constraints to define artifacts, operating scenarios and the phased roadmap.

03 / RESULTS & SCOPE

The outcome.

2Coordinated modules
GitVersioned collaboration
On-premCustomer environment

Requirements, solution proposal and screen-design outputs. Production operations and time savings were not measured in this scope.

NEXT PROJECT / 05Tago Write↗