Technical Documentation Assistant

Role Purpose & Context

Role Summary

The Technical Documentation Assistant is here to make sure our R&D breakthroughs are properly recorded and explained. You'll independently write and update a range of technical documents, from Standard Operating Procedures (SOPs) for lab experiments to detailed design specifications for new prototypes. This directly impacts how quickly our research moves from concept to reality, and frankly, how well we pass regulatory audits. You'll sit right at the heart of our R&D projects, taking raw data, interview notes, and sometimes just a whiteboard sketch, and transforming them into structured, accurate content. This documentation helps our scientists run experiments consistently, our engineers build things correctly, and our regulatory team submit applications without a hitch. When you do this job well, everyone knows exactly what to do, and our projects stay on track and compliant. If it's not done properly, we face delays, errors in the lab, and potentially serious regulatory issues. The tricky part is often getting busy scientists to give you the time and clear information you need. The reward, though, is seeing your clear documentation enable genuine scientific progress and help bring new innovations to the world.

Reporting Structure

• Reports to: Senior Technical Documentation Assistant
• Direct reports:
• Matrix relationships: Technical Writer (R&D), Documentation Specialist (Research), Junior Technical Author,

Key Stakeholders

Internal:

• R&D Scientists and Engineers
• Quality Assurance Team
• Regulatory Affairs Department
• Project Managers (R&D)
• Lab Technicians

External:

• External Auditors (occasionally)
• Regulatory Bodies (indirectly through submissions)

Organisational Impact

Scope: This role is pretty crucial for maintaining our R&D integrity and operational efficiency. You're directly responsible for ensuring that our research processes are documented clearly and accurately, which is fundamental for reproducibility, compliance, and ultimately, getting our innovations to market. Without solid documentation, even the most brilliant discovery can't be scaled, replicated, or approved. You're helping us build a reliable, auditable knowledge base.

Performance Metrics

Quantitative Metrics

1. Metric: Document Accuracy Rate
2. Desc: The percentage of documents reviewed that pass without significant factual or procedural errors.
3. Target: 99.0% or higher
4. Freq: Quarterly, based on QA and SME review feedback
5. Example: If you write 10 new SOPs and 9.9 of them pass QA review without needing factual corrections, you're hitting the mark. We're talking about things like correct chemical concentrations or instrument settings.
6. Metric: SME Review Cycle Time
7. Desc: Average time taken from sending a document for Subject Matter Expert (SME) review to receiving their final approved feedback.
8. Target: Reduce by 10% over 6 months (e.g., from 7 days to 6.3 days)
9. Freq: Monthly, tracked in our document management system (Veeva Vault)
10. Example: You send an experimental protocol to Dr. Smith. If you get their sign-off back in 5 days, that's good. We're looking for you to proactively chase and clarify to keep things moving.
11. Metric: Content Reuse Rate
12. Desc: Percentage of new content created that reuses existing approved topics, snippets, or variables.
13. Target: Increase by 15% year-on-year
14. Freq: Annually, measured through MadCap Flare's analytics or manual audit
15. Example: If you're writing a new instrument manual, and 30% of its content comes from existing, approved descriptions of common lab safety procedures or interface elements, that's a win. It means less rewriting and fewer errors.
16. Metric: Documentation Completion to Project Milestone
17. Desc: How often key documentation (e.g., final protocol) is ready before or on the associated R&D project milestone deadline.
18. Target: 95% of documents meet or beat their deadlines
19. Freq: Per project, tracked by Project Managers
20. Example: The 'Phase 1 Clinical Trial' milestone is 1st March. Your corresponding 'Clinical Protocol v1.0' needs to be signed off by 28th February. Hitting that is key.

Qualitative Metrics

1. Metric: Clarity and Usability of Documentation
2. Desc: How easy it is for the target audience (lab technicians, new engineers) to understand and follow your instructions without needing further explanation.
3. Evidence: Feedback from lab staff on SOPs; fewer 'how-to' questions directed at SMEs after documentation release; positive comments during training sessions; successful completion of tasks by users following your guides.
4. Metric: Proactive Problem Identification
5. Desc: Your ability to spot potential documentation gaps or inconsistencies early in a project, rather than waiting for them to become issues.
6. Evidence: You flag a missing step in a draft protocol before an experiment starts; you notice conflicting terminology between two related documents and propose a standard; you suggest a new template that would prevent common errors.
7. Metric: Adherence to Documentation Standards
8. Desc: How consistently you apply our internal style guides, templates, and Good Documentation Practices (GDP) without constant reminders.
9. Evidence: Your documents consistently follow our house style; you use approved terminology; metadata fields are always correctly populated in Veeva Vault; your version control is impeccable.
10. Metric: Stakeholder Collaboration & Communication
11. Desc: Your effectiveness in working with R&D teams, QA, and Regulatory Affairs to gather information and manage review cycles.
12. Evidence: SMEs comment on your organised approach to interviews; you manage to get feedback from busy people without becoming a nuisance; you clearly communicate documentation timelines and potential roadblocks.

Primary Traits

• Trait: Precise (Catches the Error)
• Manifestation: You're the person who spots that the reagent concentration on page 7 is 0.5M, but on page 12 it's accidentally typed as 5.0M. You'll notice when a diagram shows 'Valve A' closed, but the procedure says 'open Valve A'. You meticulously check every single data point in a table against the original lab log, knowing a single typo could invalidate months of work.
• Benefit: In R&D, a tiny error in documentation can have huge consequences. We're talking about invalidating a £100,000 experiment, causing a product recall, or failing a critical regulatory audit. Your precision isn't just a nice-to-have; it's a fundamental defence against costly mistakes and a core pillar of scientific integrity.
• Trait: Inquisitive (Asks 'Why?')
• Manifestation: You don't just transcribe what a scientist tells you; you'll ask, 'What's the purpose of this step for the end-user?' or 'What happens if we skip this part?' You'll proactively schedule time to watch an experiment being performed or sit with an engineer as they build a prototype, rather than just reading their notes. You'll dig into the background research to truly grasp the context of what you're documenting.
• Benefit: Our R&D teams are brilliant, but they often speak in highly specialised jargon. Your job isn't to just repeat it; it's to understand it deeply enough to translate it for different audiences. Asking 'why' helps you uncover implicit knowledge, clarify ambiguities, and ultimately create documentation that's genuinely useful and accurate, not just a word-for-word dump.
• Trait: Systematic (Loves a Good Process)
• Manifestation: You're the one who always uses the right template, even if it feels quicker to start from scratch. You meticulously follow our content reuse guidelines, knowing it saves headaches down the line. You'll keep your file naming conventions spotless and ensure every document has a complete version history. Before publishing anything, you'll run through your own internal checklist, making sure all the 'i's are dotted and 't's are crossed.
• Benefit: R&D documentation isn't a one-off task; it's a continuous, evolving asset. Without a systematic approach, our documentation library quickly becomes a chaotic mess of outdated, inconsistent, and unfindable information. Your process-minded approach ensures our content is maintainable, scalable, auditable, and actually useful for years to come. It means we can trust what's in the system.

Supporting Traits

• Trait: Patient
• Desc: You'll need a good dose of patience when dealing with busy Subject Matter Experts (SMEs) who might take a while to get back to you, or who give vague feedback. It's about persistence without being annoying.
• Trait: Self-Directed
• Desc: Once you're given a task, we expect you to mostly run with it. You'll manage your own workload, figure out who you need to talk to, and find answers independently, only escalating when you hit a genuine roadblock you can't solve.
• Trait: Articulate
• Desc: You need to be able to explain complex scientific or technical concepts clearly and concisely, both in writing and when you're talking to people. No waffling, just clear, direct communication.
• Trait: Collaborative
• Desc: You won't be working in a silo. You'll be constantly interacting with scientists, engineers, quality assurance, and regulatory affairs folks. Being able to work well with different personalities and priorities is key.

Primary Motivators

1. Motivator: Making Complex Things Clear
2. Daily: You get a real kick out of taking a dense, jargon-filled research paper or an engineer's scribbled notes and turning it into something genuinely understandable for a wider audience. It's like solving a puzzle every day.
3. Motivator: Contributing to Scientific Progress
4. Daily: You're motivated by the knowledge that your meticulous documentation directly supports groundbreaking research and helps bring new medical devices or treatments to market. You see the bigger picture beyond just words on a page.
5. Motivator: Building Organised Systems
6. Daily: You genuinely enjoy setting up and maintaining structured content, ensuring consistency, and making information easy to find and reuse. The idea of a well-organised knowledge base excites you.

Potential Demotivators

Honestly, this role isn't for everyone. If you need constant, immediate gratification from seeing your work directly 'ship' as a product, you might struggle. Your impact is often indirect but profound. You'll spend a fair bit of time chasing busy scientists for feedback, and sometimes you'll feel like you're pulling teeth. There will be days where you're handed a messy, decade-old document and asked to 'just update it' without much context, which can feel like document archaeology. If you hate repetitive tasks like ensuring every single cross-reference is correct, or meticulously checking version numbers, this might grind you down.

Common Frustrations

1. Chasing busy Subject Matter Experts (SMEs) for review and approval, often feeling like a broken record.
2. Getting conflicting feedback from different stakeholders and having to mediate or clarify.
3. Being brought into a project late, meaning you're playing catch-up and documenting something that's already mostly built.
4. The perception that your job is 'just spell-checking' or 'typing up notes' rather than a critical information architecture role.
5. Dealing with legacy documentation that's poorly organised, inconsistent, or just plain wrong, and having to untangle it.

What Role Doesn't Offer

1. Direct hands-on involvement in lab experiments or product design (you're documenting it, not doing it).
2. A purely creative writing role; precision and clarity trump flair here.
3. A role where you can avoid strict regulatory guidelines and formal processes.
4. A quiet, isolated environment where you don't have to interact with many different people.

ADHD Positives

1. The need to constantly switch between different documents and projects can keep things fresh and engaging, preventing boredom.
2. The investigative nature of gathering information from various sources (interviews, documents, observation) can be a good fit for curious minds.
3. The problem-solving aspect of clarifying complex information into clear steps can be stimulating.

ADHD Challenges and Accommodations

1. Meticulous detail-checking and repetitive proofreading might be challenging; using tools like Acrolinx for automated checks can help significantly.
2. Managing multiple review cycles and chasing SMEs requires sustained focus; using project management tools with clear reminders and structured templates can provide external scaffolding.
3. Staying organised with version control and file structures is critical; clear, enforced team standards and automated systems (Git, Veeva Vault) can reduce cognitive load.

Dyslexia Positives

1. The focus on clear, concise, and structured writing (often using templates) can be beneficial, as it reduces the need for highly creative or unstructured text.
2. Strong conceptual understanding and ability to grasp complex systems are highly valued, often a strength for dyslexic thinkers.
3. The use of visual tools like Lucidchart/Visio for diagrams is a key part of the role, playing to visual strengths.

Dyslexia Challenges and Accommodations

1. Proofreading and catching typos in long documents can be demanding; using grammar and style checkers (Acrolinx) and having a peer review process is essential.
2. Strict adherence to style guides and terminology might require extra effort; automated tools can help enforce these rules.
3. Reading dense, technical source material can be tiring; providing text-to-speech software or allowing for audio summaries of research papers could be helpful.

Autism Positives

1. The role requires a high degree of precision, logical thinking, and adherence to established processes, which often aligns well with autistic strengths.
2. Working with structured data, templates, and clear guidelines can be comforting and efficient.
3. The ability to deep-dive into complex technical details and understand systems thoroughly is a significant asset.

Autism Challenges and Accommodations

1. Frequent, often unstructured interactions with Subject Matter Experts for information gathering can be draining; clear meeting agendas, written questions in advance, and scheduled 'focus time' can help manage this.
2. Interpreting implicit feedback or navigating conflicting opinions from different SMEs might be difficult; encouraging direct, explicit communication and providing a clear conflict resolution process is important.
3. Changes to established processes or unexpected 'last-minute bombshells' can be disruptive; providing as much advance notice as possible and clear rationales for changes can help.

Key Responsibilities

Experience Levels Responsibilities

1. Level: Mid-Level (2-5 years)
2. Responsibilities: Independently author new Standard Operating Procedures (SOPs), experiment protocols, and technical reports for specific R&D projects from start to finish. This means gathering information, drafting, and managing the review cycle.
3. Take ownership of updating and maintaining existing documentation for your assigned projects. You'll make sure they reflect the latest research findings, instrument changes, or regulatory requirements.
4. Identify inconsistencies or gaps in our current documentation and propose solutions. This isn't just about fixing what's broken, but proactively making things better.
5. Create and edit complex diagrams, flowcharts, and screenshots using tools like Lucidchart or Snagit to clearly illustrate scientific processes or system architectures.
6. Manage the full document lifecycle for your assigned content within Veeva Vault, ensuring proper version control, metadata tagging, and adherence to Good Documentation Practices (GDP).
7. Collaborate closely with R&D scientists, engineers, and QA specialists to extract technical information, clarify ambiguities, and gather feedback on your drafts. You'll often be the one driving these conversations.
8. Apply our content reuse strategy, using conditional text and snippets in MadCap Flare to single-source content for multiple outputs (e.g., internal wiki, regulatory submission PDF).
9. Supervision: You'll typically have weekly check-ins with your Senior Technical Documentation Assistant or manager. For routine tasks, we expect you to work independently, only escalating novel or particularly tricky problems. We trust you to manage your own day-to-day workload.
10. Decision: You'll make routine technical decisions within your project scope, like choosing the best way to structure a topic or selecting the right diagramming tool for a specific illustration. You can propose changes to documentation templates or style guide updates, but these would need approval from your Senior or Lead. Any budget decisions or significant timeline changes need to be escalated to your manager.
11. Success: You're successful when your documents are consistently accurate, clear, and delivered on time for your assigned projects. When SMEs give positive feedback on your drafts, and you're proactively identifying improvements, you're doing well. Catching most errors before they go to final review is also a key indicator.

Decision-Making Authority

• Type: Content Structure & Approach
• Entry: Follows pre-defined templates and structures; requires approval for any deviation.
• Mid: Chooses appropriate structure and approach for new documents within established guidelines; proposes minor template adjustments for review.
• Senior: Designs new content structures and templates for complex projects; makes recommendations for overall information architecture improvements.
• Type: Technical Accuracy & Detail
• Entry: Relies heavily on SME input for technical validation; flags any perceived inconsistencies.
• Mid: Independently verifies technical details against source material; identifies and resolves minor inconsistencies with SME consultation.
• Senior: Acts as a primary technical reviewer for junior writers; challenges SMEs for clarity and precision; resolves complex technical ambiguities.
• Type: Tool & Software Usage
• Entry: Uses specified tools (e.g., MadCap Flare, Veeva Vault) for assigned tasks under guidance.
• Mid: Independently uses core documentation tools; explores advanced features to optimise own workflow; suggests new tool integrations for discussion.
• Senior: Evaluates new documentation tools and technologies; defines best practices for tool usage across the team; troubleshoots complex tool issues.
• Type: Project Timelines & Priorities
• Entry: Works to deadlines set by supervisor; communicates progress and roadblocks.
• Mid: Manages own documentation project timelines; proactively communicates potential delays and proposes solutions; prioritises tasks for assigned projects.
• Senior: Negotiates documentation timelines with project managers; identifies and mitigates risks to documentation delivery; helps prioritise team workload.

Competency Requirements

Foundation Skills (Transferable)

These are the core skills that underpin everything you'll do. They're not just 'nice-to-haves'; they're essential for getting the job done well and working effectively with everyone in R&D.

• Category: Communication & Collaboration
• Skills: Active Listening: You'll need to really hear what scientists are saying, even when they're speaking in highly technical terms or quickly.
• Clear Written Communication: Crafting precise, unambiguous sentences that leave no room for misinterpretation, especially in regulated documents.
• Interviewing Skills: Knowing how to ask the right questions to extract critical information from busy Subject Matter Experts (SMEs).
• Feedback Incorporation: Taking on board review comments from multiple stakeholders, even when they're contradictory, and finding a path forward.
• Cross-functional Teamwork: Working smoothly with R&D, QA, and Regulatory Affairs to get things done.
• Category: Problem-Solving & Critical Thinking
• Skills: Information Synthesis: Taking disparate pieces of information (lab notes, diagrams, verbal explanations) and piecing them together into a coherent whole.
• Ambiguity Resolution: Identifying when information is unclear or incomplete and knowing how to get clarification.
• Logical Structuring: Organising complex procedures or concepts into a clear, step-by-step, easy-to-follow format.
• Error Detection: Spotting inconsistencies, factual errors, or omissions in technical content, both your own and others'.
• Category: Organisation & Planning
• Skills: Time Management: Juggling multiple documentation tasks and review cycles to meet project deadlines.
• Workflow Management: Planning your work, managing your own review queues, and proactively chasing feedback.
• Attention to Detail: Meticulous checking of facts, figures, grammar, and adherence to style guides.
• Document Version Control: Keeping track of document iterations and changes accurately in a formal system.
• Category: Adaptability & Learning
• Skills: Technical Aptitude: Quickly grasping new scientific concepts, experimental procedures, or engineering designs.
• Tool Proficiency: Rapidly learning and becoming proficient in new software and documentation tools.
• Process Adherence: Adapting to and consistently following established documentation processes and regulatory guidelines.
• Continuous Improvement Mindset: Always looking for ways to make documentation clearer, more efficient, or more compliant.

Functional Skills (Role-Specific Technical)

These are the specific methodologies, tools, and industry knowledge you'll use every single day. We're looking for someone who's already got a good grasp of these, or can pick them up quickly.

Technical Competencies

• Skill: DITA (Darwin Information Typing Architecture)
• Desc: Understanding and applying topic-based authoring principles (Concept, Task, Reference) to create modular, reusable content. You'll be using this to break down complex information into manageable, reusable chunks.
• Level: Intermediate
• Skill: Docs-as-Code Principles
• Desc: Treating documentation with the same rigour as software development, using version control (Git) and plain-text authoring formats. You'll understand why this matters for collaboration and automation.
• Level: Intermediate
• Skill: Minimalism in Technical Writing
• Desc: Focusing on action-oriented, user-centric content. Writing just enough for the user to succeed, avoiding verbose explanations and unnecessary 'nice-to-know' information that clutters procedures.
• Level: Intermediate
• Skill: Single-Source Publishing
• Desc: Applying techniques to write content once and publish it to multiple outputs (e.g., PDF for regulatory submission, HTML5 for internal knowledge base) using conditional text and variables.
• Level: Intermediate
• Skill: Information Architecture Basics
• Desc: Structuring and organising moderate volumes of technical information logically. You'll be thinking about how users will find and use the information you're creating.
• Level: Intermediate

Digital Tools

• Tool: MadCap Flare
• Level: Intermediate
• Usage: Creating new topics, editing existing content, applying conditional tags for different outputs, and generating basic PDF or HTML5 builds from pre-configured targets. You'll be comfortable navigating projects and using variables.
• Tool: Git (via GitHub/GitLab)
• Level: Intermediate
• Usage: Cloning documentation repositories, committing your changes to existing branches, handling basic pull requests, and resolving simple merge conflicts with some guidance. You'll understand the basics of version control.
• Tool: Veeva Vault (or similar DMS like SharePoint)
• Level: Intermediate
• Usage: Uploading new documents, populating all required metadata fields accurately, navigating documents through their review and approval lifecycles, and managing version control for controlled documents.
• Tool: Acrolinx
• Level: Intermediate
• Usage: Running quality checks on your content before submission, correcting grammar, style, and terminology issues based on the scorecard feedback, and understanding how to improve your writing for consistency.
• Tool: Snagit / Camtasia
• Level: Intermediate
• Usage: Capturing and annotating screenshots with professional callouts, creating simple screen-capture videos to illustrate procedures, and editing images for clarity and impact.
• Tool: Lucidchart / Visio
• Level: Intermediate
• Usage: Designing complex process maps, system architecture diagrams, and data flow illustrations from scratch, working from SME input to create clear visualisations.

Industry Knowledge

• Area: Good Documentation Practice (GDP/GxP)
• Desc: Adhering to strict regulatory requirements for creating, reviewing, approving, and retaining documentation in life sciences R&D. You'll understand why every entry needs to be attributable, legible, and traceable, and how to apply these principles daily.
• Area: R&D Project Lifecycle
• Desc: A solid understanding of how research projects move from concept to development, testing, and potential commercialisation. Knowing this helps you anticipate documentation needs at each stage.
• Area: Scientific Terminology
• Desc: Familiarity with common scientific and engineering terms relevant to our specific research areas (e.g., molecular biology, materials science, clinical trials). You don't need to be an expert, but you shouldn't be completely lost.

Regulatory Compliance Regulations

• Reg: ISO 9001 (Quality Management Systems)
• Usage: You'll understand how your documentation contributes to our quality management system, particularly regarding document control, record keeping, and ensuring processes are clearly defined and followed.
• Reg: GxP (Good 'X' Practices - e.g., GLP, GCP, GMP)
• Usage: You'll apply the principles of GxP to all relevant R&D documentation, ensuring data integrity, traceability, and proper record-keeping for lab studies (GLP), clinical trials (GCP), or manufacturing (GMP) where applicable.
• Reg: Data Integrity Principles
• Usage: You'll ensure that all documentation you create or manage upholds data integrity principles, meaning information is accurate, complete, consistent, and recorded in a way that prevents alteration or loss.

Essential Prerequisites

• At least 2-3 years of proven experience writing technical documentation in a regulated industry, ideally R&D, life sciences, or engineering.
• Demonstrable experience with a component content management system (CCMS) like MadCap Flare, or a similar structured authoring tool.
• A strong portfolio or examples of technical documents you've authored, showing clarity, accuracy, and adherence to style guides.
• Experience working directly with Subject Matter Experts to extract and validate complex technical information.
• A solid grasp of version control principles, ideally with some hands-on experience using Git or a similar system.

Career Pathway Context

These prerequisites mean you're not starting from scratch. You've been around the block a few times in documentation and understand the basics of working in a technical, often regulated, environment. This role builds on that foundation, giving you more autonomy and ownership over your projects.

Qualifications & Credentials

Emerging Foundation Skills

• Skill: Prompt Engineering & LLM Integration
• Why: Our competitors are already using AI (Large Language Models) to draft reports in minutes that used to take hours. Those who figure this out will outproduce their peers significantly. This isn't just a 'nice to have' anymore; it's becoming a productivity superpower.
• Concepts: [{'concept_name': 'Context Windows & Token Limits', 'description': "Understanding how much information an AI can 'remember' at once and how to manage input/output size effectively."}, {'concept_name': 'Temperature Settings', 'description': 'Knowing how to adjust AI creativity for different tasks—low for factual accuracy, higher for brainstorming.'}, {'concept_name': 'RAG (Retrieval Augmented Generation)', 'description': 'Learning how to connect LLMs to our own proprietary R&D data so they can generate accurate content based on our internal knowledge.'}, {'concept_name': 'Output Validation & Hallucination Detection', 'description': "Developing a critical eye to verify AI-generated content, spotting inaccuracies or 'made-up' information."}, {'concept_name': 'Prompt Chaining', 'description': 'Breaking down complex documentation tasks into a series of smaller, linked AI prompts to achieve better results.'}]
• Prepare: This week: Start experimenting with ChatGPT or Claude to draft email summaries, meeting notes, or even simple code comments. Just get comfortable with the interface.
• This month: Try to use an LLM to generate a first draft of a simple 'Concept' topic based on a few bullet points you provide. Focus on structure and tone.
• Month 2: Research RAG architectures. Think about how we could feed our internal Veeva Vault documents into an LLM to get more accurate, context-specific drafts.
• Month 3: Document your productivity gains. Share what worked (and what didn't) with your team. Show us how you're saving time.
• QuickWin: Start using AI to summarise long emails or research papers today. No approval needed, immediate benefit to your reading load.
• Skill: Data Visualisation Storytelling
• Why: R&D data is getting more complex, and static diagrams sometimes don't cut it. We need to tell a clearer story with data, making it interactive and more impactful. This isn't just about making pretty charts; it's about making data-driven decisions easier.
• Concepts: [{'concept_name': 'Interactive Dashboards (e.g., Power BI, Tableau)', 'description': 'Learning how to create dynamic visualisations that allow users to explore data themselves.'}, {'concept_name': 'Infographic Design Principles', 'description': 'Understanding how to combine text, images, and data to communicate complex information quickly and effectively.'}, {'concept_name': 'Narrative Visualisation', 'description': 'Structuring data visualisations to guide the user through a specific story or insight, rather than just presenting raw numbers.'}, {'concept_name': 'Accessibility in Visualisation', 'description': 'Ensuring that data visualisations are understandable and usable for everyone, including those with visual impairments.'}, {'concept_name': 'Choosing the Right Chart Type', 'description': 'Knowing which chart (bar, line, scatter, etc.) best represents different types of data and insights.'}]
• Prepare: This week: Explore free online tutorials for Power BI or Tableau. Try to recreate a simple chart from one of our R&D reports.
• This month: Take one of your existing Lucidchart diagrams and think about how you could make it more interactive or data-driven. Could it link to live data?
• Month 2: Find a complex R&D dataset (maybe from a public source) and try to build a simple interactive dashboard that tells a story.
• Month 3: Present a 'before and after' of one of your visualisations to your team, showing how you made it more impactful.
• QuickWin: Start using more icons and less text in your existing diagrams. Think about how to simplify complex flowcharts into a clearer visual narrative.

Advancing Technical Skills

• Skill: Advanced MadCap Flare Features
• Why: As our content library grows and our publishing needs become more complex, you'll move beyond basic topic creation to truly master Flare's power features for efficiency and consistency.
• Concepts: [{'concept_name': 'Advanced Snippets & Variables', 'description': 'Using nested snippets, global variables, and conditional variables to manage highly dynamic content.'}, {'concept_name': 'Micro Content & Search Optimisation', 'description': 'Creating bite-sized content for chatbots or search results, and optimising Flare output for better search engine visibility.'}, {'concept_name': 'Source Control Integration', 'description': 'Deepening your understanding of how Flare integrates with Git for collaborative authoring and version management.'}, {'concept_name': 'Custom Targets & Skins', 'description': 'Designing and building custom publishing targets and skins to meet specific branding or output requirements.'}]
• Prepare: This week: Dive into Flare's online help for 'Variables' and 'Snippets'. Try to convert a repeated phrase in your current project into a variable.
• This month: Experiment with creating a custom output target that uses a different stylesheet or conditional text setting.
• Month 2: Explore Flare's 'Micro Content' feature. Think about how you could use it for FAQs or chatbot responses.
• Month 3: Shadow a Senior Technical Documentation Assistant to see how they use advanced Flare features in a real-world project.
• QuickWin: Identify 3-5 frequently used terms or phrases in your current documents and convert them into project-level variables in Flare.
• Skill: Deepening Docs-as-Code & Git Workflow
• Why: As our R&D software and documentation processes become more integrated, a robust docs-as-code workflow is essential. You'll need to move beyond basic Git commands to truly own your content's versioning.
• Concepts: [{'concept_name': 'Branching Strategies (e.g., GitFlow)', 'description': 'Understanding different ways to manage parallel development of documentation and how to apply them.'}, {'concept_name': 'Complex Merge Conflict Resolution', 'description': 'Becoming proficient at resolving more intricate conflicts when multiple people edit the same files.'}, {'concept_name': 'Pull Request Best Practices', 'description': 'Writing clear pull request descriptions, conducting effective code/content reviews, and managing the merge process.'}, {'concept_name': 'Basic CI/CD Pipeline Understanding', 'description': "Grasping how automated builds and deployments work for documentation, even if you're not setting them up yourself."}]
• Prepare: This week: Review our team's Git branching strategy. Understand why we use it.
• This month: Practice resolving a simulated merge conflict with a peer. Get comfortable with the tools.
• Month 2: Propose an improvement to our pull request template or review process.
• Month 3: Ask to sit in on a session where a Lead or Senior discusses a CI/CD pipeline for documentation.
• QuickWin: Ensure all your Git commit messages are clear, concise, and follow our team's conventions. This improves traceability for everyone.

Education Requirements

• Level: Minimum
• Req: A Bachelor's degree in a scientific, engineering, technical communication, or related field.
• Alts: Alternatively, a strong portfolio demonstrating 4+ years of relevant technical documentation experience in a complex R&D or regulated environment could be considered in lieu of a degree. We value practical skills and proven ability.
• Level: Preferred
• Req: A Master's degree in Technical Communication, Science Communication, or a relevant scientific/engineering discipline.
• Alts: Not strictly necessary, but it certainly shows a deeper commitment to the field or a stronger technical foundation.

Experience Requirements

You'll need at least 2-5 years of dedicated experience as a Technical Writer or Documentation Specialist, specifically within a Research & Development, life sciences, pharmaceutical, or medical device setting. This isn't just about writing; it's about understanding the nuances of regulated documentation, working with complex scientific information, and managing review cycles with busy SMEs. We're looking for someone who has independently owned documentation projects from start to finish, not just made edits.

Preferred Certifications

• Cert: Certified Professional Technical Communicator (CPTC)
• Prod: Society for Technical Communication (STC)
• Usage: Demonstrates a broad understanding of technical communication principles and best practices, which is always a plus.
• Cert: MadCap Flare Certification
• Prod: MadCap Software
• Usage: Shows a deeper proficiency with our primary authoring tool, meaning you'll get up to speed faster and be able to use its advanced features more effectively.
• Cert: Good Documentation Practice (GDP) Training
• Prod: Various industry providers
• Usage: Highlights your understanding of the critical regulatory requirements for documentation in R&D, which is non-negotiable for us.

Recommended Activities

• Attending industry conferences or workshops focused on technical communication, DITA, or content strategy.
• Participating in online courses or webinars on advanced MadCap Flare techniques or Git for documentation.
• Reading relevant industry publications and blogs to stay current with best practices and emerging tools.
• Joining professional organisations like the Institute of Scientific and Technical Communicators (ISTC) in the UK.

Career Progression Pathways

Entry Paths to This Role

• Path: Junior Technical Writer / Documentation Assistant
• Time: 2-3 years
• Path: Scientific Editor / Research Assistant with Documentation Focus
• Time: 3-4 years
• Path: Software Documentation Specialist (transfer from another industry)
• Time: 2-4 years

Career Progression From This Role

• Pathway: Senior Technical Documentation Assistant
• Time: 3-5 years in current role

Long Term Vision Potential Roles

• Title: Lead Technical Documentation Assistant / Information Architect
• Time: 5-8 years from current role
• Title: Documentation Manager / Principal Information Architect
• Time: 8-12 years from current role
• Title: Director of Content & Knowledge Management (R&D)
• Time: 12-15 years from current role

How Zavmo Delivers This Role's Development

DISCOVER Phase: Skills Gap Analysis

Zavmo maps your current competencies against all requirements in this job description through conversational assessment. We evaluate your foundation skills (communication, strategic thinking), functional skills (CRM expertise, negotiation), and readiness for career progression.

Output: Personalised skills gap heat map showing strengths and priorities, estimated time to competency, neurodiversity accommodations.

DISCUSS Phase: Personalised Learning Pathway

Based on your DISCOVER results, Zavmo creates a personalised learning plan prioritised by impact: foundation skills first, then functional skills. We adapt to your learning style, pace, and neurodiversity needs (ADHD, dyslexia, autism).

Output: Week-by-week schedule, each module linked to specific job responsibilities, checkpoints and milestones.

DELIVER Phase: Conversational Learning

Learn through conversation, not boring modules. Zavmo uses 10 conversation types (Socratic dialogue, role-play, coaching, case studies) to build competence. Practice difficult QBR presentations, negotiate tough renewals, and handle churn conversations in a safe AI environment before facing real clients.

Example: "For 'Stakeholder Mapping', Zavmo will guide you through analysing a complex enterprise account, identifying key decision-makers, and building an engagement strategy."

DEMONSTRATE Phase: Competency Assessment

Zavmo automatically builds your evidence portfolio as you learn. Every conversation, practice scenario, and application example is captured and mapped to NOS performance criteria. When ready, your portfolio supports OFQUAL qualification claims and demonstrates competence to employers.

Output: Competency matrix, evidence portfolio (downloadable), qualification readiness, career progression score.