Tech Writing Tips: 15 Tactics to Speed Up Doc Review | by Ina Ciobanu | Dec, 2023


Extracting (yes, it’s the right verb) timely feedback from Subject Matter Experts (SMEs) and stakeholders is a common challenge for technical writers. Someone described the process as “Just unpleasant. Prepare to go outside for a primal scream afterward.”

Image sources: Archbee, Quora.

Since life is too short for such experiences, I’m sharing 15 ways to streamline doc review and reduce friction once and for all:

1. Set Clear Deadlines: It’s crucial to state a due date and time for feedback in your document or communication. You can include a statement like, “Feedback is due by [X date and time], and lack of feedback will be considered as approval.”

2. Send Email Notifications: Use email to send out requests for feedback and reminders. Many project management and collaboration tools allow you to automate email reminders, which can help keep stakeholders informed. Get some inspiration from this article.

Dealing with Difficult Stakeholders. (Image source: ModernAnalyst)

3. Direct Messaging: Reach out to stakeholders directly through communication channels like Slack, Teams, or other messaging platforms. A direct message can be more effective than a broad email reminder, as it creates a sense of personal responsibility.

4. Polite Persistence: Sometimes, polite persistence is necessary. If you don’t receive feedback after the initial request or reminders, send a follow-up message, expressing your eagerness to address their concerns. Emphasize that their input is valuable.

5. Automated Reminder Messages: In addition to the initial request, consider sending automated reminder messages as the deadline approaches. For example, you can set up an automated reminder to be sent 24 hours before the feedback deadline. This serves as a gentle nudge.

Image source: Best Practices In Creating Workflows.

6. Meeting Invitations: If stakeholders are unresponsive, booking a brief meeting to discuss the document can be an effective tactic. This may prompt them to review the document in advance to contribute meaningfully…



Source link

Previous articleAnalyst Sees Bitcoin Move To $69,000 As Cup And Handle Pattern Appears
Next articleiMessage for Android via Beeper Mini and Cloud are down again