Fixing document reviews with templates and training for engineers

I created design document templates, ran training on process maturity and compliance for hundreds of engineers, and helped teams use version control, so work stopped being lost and rewritten.

At a glance
Role: Technical Writer
Client: A technology company with several engineering sub-teams
Worked with: Engineers, document reviewers and the Architecture Review Board
Duration: 2 years
Focus: Templates, first-level compliance reviews, a document library, and training on process maturity and compliance
Result: Templates and training for hundreds of engineers, with version control adopted to prevent lost content

The challenge
The client’s design documents often had grammar errors and didn’t meet compliance standards. Many engineers weren’t familiar with how to write design documentation, so their documents failed reviews. Those failures halted work and delayed deliveries to customers.

What I did

• Created product-specific templates for high-level and low-level design documents, so engineers started from a correct structure
• Supported the reviewer with first-level compliance checks, so errors were caught before formal review
• Built and maintained an online library of templates, organized the folders, archived old documents and gave the right people access
• Trained hundreds of engineers on process maturity and compliance, including version control, so that documents were stored, tracked and updated properly
• Worked with several stakeholders to collect approved design documents and shape the product templates
• I used storytelling to narrate the importance of compliance and client feedback, and trained engineers about process maturity and its execution.

The result

• Templates for high-level and low-level design documents across 10 products
• Training delivered to hundreds of engineers on process maturity, compliance and documentation
• Engineers began using version control for their documents, which saved the time that had been lost recreating missing or overwritten content
• Reviews happened quicker because of my aid

What I learned about leading
Training hundreds of engineers showed me that every room is full of people who are ready to learn. Coming to the work as a writer, I found that strong technical skills and a love of learning go hand in hand. Each session reminded me that growth belongs to everyone, whatever their field, and that a learning mindset is what makes a team move forward together. I grew as much as the people I trained.

Skills shown: Standards and templates, training and mentoring, stakeholder coordination, quality review, documentation systems, version control