New Technical Writer Avoiding The Interview-writing Disconnect
Below is a MRR and PLR article in category Writing Speaking -> subcategory Writing.
How New Technical Writers Can Avoid the Interview-Writing Disconnect
Summary:
Lost or misunderstood information from interviews can be a significant waste, particularly when it's crucial for user documentation. Here's how new technical writers can ensure that doesn't happen.
---
The Challenge:
You've interviewed a Subject Matter Expert (SME) to gather essential information for your product's user documentation. Despite an insightful session, details become fuzzy by the time you start writing. This is known as the "Interview-Writing Disconnect."
The Solution:
Addressing this disconnect involves three phases: Preparation Before the Interview, Actions During the Interview, and Steps Following the Interview.
Before the Interview:
1. Preparation is Key: Become familiar with the product, its environment, the intended users, and their goals. The more informed you are, the more productive the interview will be.
2. Set Clear Goals: Define the objectives of your interview and share them with the SME via email beforehand.
3. Record the Session: If permitted, use a digital recorder to capture the conversation. Ensure your recording device is functional before the interview starts.
4. Organize Your Materials: Have everything you need ready, including any pre-prepared questions and note-taking tools.
Leave Your Ego Aside:
Admit when you don’t understand something and ask questions until you do. Inform the SME: "If I ask what seems like a basic question, it's to align with our User's perspective."
During the Interview:
1. Start Broad: Begin with general questions such as:
- What is this portion of the product called?
- How does this section fit into the overall product?
- What is this section used for and when?
2. Dive Deeper: After gaining background information, proceed with specific operational questions, both pre-prepared and spontaneous.
3. Clarify and Summarize: Repeat key points in your own words, and ask the SME to correct any misunderstandings.
4. Document Observations: Verbally describe any actions or demonstrations by the SME to provide context for your audio recording.
5. Take Efficient Notes: Supplement your recording with notes, and try not to interrupt the flow of the interview.
6. Utilize Handouts: If handouts are provided, note on them and verbally link them with your recordings when possible.
After the Interview:
1. Prompt Review: Go over your notes and expand upon them immediately after the interview, if possible. Add enough detail for someone who wasn't in the interview to understand?"essentially future-proof them for yourself.
2. Draft Quickly: Convert your expanded notes into a draft soon after the interview, ideally within a day or two.
3. Revisit and Refine: After letting the draft sit briefly, review and edit for clarity and completeness. Consider having the SME review the content for accuracy, focusing solely on the content, not grammar.
4. Plan Your Time: Allocate specific time for writing, even amidst multiple projects. This dedicated time minimizes the risk of losing critical details.
Conclusion:
Avoiding the Interview-Writing Disconnect involves thorough preparation, diligent questioning and note-taking during interviews, and prompt follow-up writing. By following these steps, new technical writers can ensure clarity and accuracy in their user documentation.
You can find the original non-AI version of this article here: New Technical Writer Avoiding The Interview-writing Disconnect.
You can browse and read all the articles for free. If you want to use them and get PLR and MRR rights, you need to buy the pack. Learn more about this pack of over 100 000 MRR and PLR articles.