In this episode, Pooja Laxmeshwar, a Technical Writer at BAI Communications, provides a comprehensive overview of topic-based authoring and single-sourcing and discusses how single-source authoring goes beyond reusing content.
Watch the Video Podcast here
About Pooja
- Pooja’s LinkedIn
- She completed her bachelor’s degree in computer applications, where she developed a strong interest in coding and programming.
- Initially drawn to journalism, she pursued a master’s in media studies, where she discovered technical writing—a field that felt like a natural fit.
- Soon after, she began applying for technical writing roles and secured a job through campus placement.
Key Takeaways
- According to Pooja, topic-based authoring is one of the efficient ways of writing as it helps to break down the entire project into smaller bits that are easy to consume.
- Not all stakeholders may support topic-based authoring since it involves reviewing multiple small snippets. Emphasizing the value of brief, targeted snippets versus lengthy documents can be essential. Presenting quantitative data to show the efficiency of topic-based writing is also important.
- Compared to lengthy documents, topic-based authoring enables quicker information retrieval, with added benefits like clickable links and related articles.
- In roles with numerous documents, single sourcing enables efficient quality checks. For instance, with over 150 processes to document, reusing core steps ensures accuracy and quality.
- With single sourcing, specific sections of documents, such as paragraphs or tables, can be translated instead of translating the whole document. This could also help in saving project cost.
- “Consistent information delivery across multiple formats, such as manuals and process documents, becomes more manageable with single sourcing”, adds Pooja.
- Technical writers’ timelines often depend on the pace and priorities of cross-functional teams. Managing a high volume of documents while aligning with engineering and business teams’ deadlines is a significant challenge.
Rapid fire with Pooja Laxmeshwar
-
Highly recommended resource
Resources from Write the Docs and try to interact with a lot of technical writers
-
One word that comes to your mind when you hear documentation
Concise
-
A piece of advice you would give your 20-year-old self
Trust the process fully. Write down each step, gather feedback, and remember that everything in documentation aligns with the bigger picture.