Skip to main content

Writing guidelines

Writing guidelines for a Design System for embedded AI need to account for the nuances of AI interactions, including the need for clarity, empathy, and adaptability. These guidelines should ensure that the written content effectively communicates with users in a way that is both informative and supportive, leveraging the AI’s capabilities. Here’s how writing guidelines would be uniquely tailored:

1. Clarity and Precision:​

  • AI-Supported Content Creation: Ensure that all written content is clear, concise, and precise, making it easier for AI to process and interpret user inputs. This is particularly important for natural language processing (NLP) systems where ambiguity can lead to errors or misunderstandings.
  • Avoiding Ambiguity: Guidelines should emphasize avoiding ambiguous language that could confuse users or the AI. For example, content should use specific terminology rather than vague or general terms, especially when providing instructions or prompts.

2. User-Centric Language:​

  • Personalization: The writing guidelines should encourage using language that can be easily personalized by AI based on user profiles or behaviors. This includes using placeholders for user names, roles, or preferences that the AI can fill in dynamically.
  • Empathy and Support: Writing should be empathetic, reflecting an understanding of the user's context, challenges, and emotional state. The AI should be able to adapt the tone based on real-time analysis of user interactions, offering supportive and encouraging language when needed.

3. Adaptable Tone and Style:​

  • Context-Aware Tone: The guidelines should provide frameworks for adjusting tone based on the context of the interaction. For example, the AI might use a more formal tone in professional settings and a casual tone in more relaxed environments. This adaptability ensures that the content remains appropriate and engaging.
  • Dynamic Tone Shifts: Content should be designed to allow for dynamic tone shifts, where the AI can change the writing style based on user preferences or emotional cues, such as switching from a neutral to a more motivational tone during challenging tasks.

4. Inclusive and Accessible Language:​

  • Cultural Sensitivity: The writing guidelines should promote the use of culturally sensitive language that can be easily localized by AI. This includes avoiding idioms or phrases that might not translate well across different languages and cultures.
  • Accessibility Considerations: Language should be inclusive and accessible, avoiding jargon or complex terminology unless necessary. The AI should be able to provide explanations or simplifications of terms when interacting with users who might need additional support.

5. Consistency Across Interactions:​

  • Standardized Terminology: Establish standardized terminology that the AI uses consistently across all interactions. This ensures that users become familiar with key terms and phrases, reducing confusion and improving the overall user experience.
  • Uniform Writing Style: The writing style should be consistent across all AI-driven content, from UI elements to help documentation. This consistency helps build trust and reliability, making the system feel cohesive and well-integrated.

6. Proactive and Predictive Communication:​

  • Anticipatory Guidance: Guidelines should support writing that allows AI to offer proactive assistance and predictive communication. For instance, the AI might preemptively address common user questions or concerns before they arise, using language that anticipates needs.
  • Predictive Prompts: The AI should use language that guides users toward their next steps, predicting what they might need to do next based on their current actions. This can be achieved by writing prompts that suggest actions or ask guiding questions.

7. Transparency and Trust:​

  • Explainable AI Communication: Guidelines should ensure that the AI’s decisions and actions are communicated transparently. For example, when AI makes a suggestion or takes an action, the content should clearly explain why this choice was made, using straightforward and trustworthy language.
  • Building User Trust: The writing should reinforce trust by being honest about the AI’s capabilities and limitations. For instance, if the AI cannot complete a task, the language should acknowledge this and offer alternative solutions or paths.

8. Error Handling and Recovery:​

  • Friendly and Helpful Error Messages: When errors occur, the writing should be friendly, non-technical, and constructive, helping users understand what went wrong and how to fix it. The AI should be able to tailor these messages to the user’s level of expertise, offering more detailed guidance to those who need it.
  • Graceful Recovery Suggestions: The AI should provide suggestions for recovering from errors or mistakes, using language that is encouraging and supportive, rather than punitive. This helps maintain user confidence and reduces frustration.

9. User Feedback Integration:​

  • Encouraging Feedback: The guidelines should encourage the use of language that invites user feedback, making it clear that their input is valued and will be used to improve the AI system. For example, prompts might ask users if the AI’s suggestion was helpful or how the experience could be improved.
  • Adaptive Learning from Feedback: Content should be structured so that the AI can learn from user feedback and adapt future interactions accordingly. This might involve writing scripts that allow for easy modification based on user input, ensuring continuous improvement.

10. Educational and Informative Content:​

  • Guiding User Learning: Writing should be educational, guiding users on how to use AI features effectively. The AI can provide tips, tutorials, or inline explanations that help users learn while they work, using language that is clear and instructional.
  • Knowledge Reinforcement: Content should reinforce key concepts or features through repetition and reinforcement, helping users retain information. The AI might reintroduce certain tips or reminders based on user behavior, using consistent and reinforcing language.

11. Security and Privacy Communication:​

  • Clear Privacy Explanations: The writing should include clear explanations of how user data is handled, with the AI transparently communicating privacy policies and security measures. This builds trust and helps users feel confident in their interactions with the system.
  • Secure Communication Practices: Ensure that all communication related to security is clear, direct, and emphasizes the importance of safeguarding personal information. The AI should use language that reassures users while guiding them through secure practices.

12. Multi-Channel Consistency:​

  • Cross-Platform Language Consistency: Writing guidelines should ensure that the language used by AI is consistent across all channels and platforms, whether in-app, via email, or through chatbots. This consistency helps create a unified user experience and reinforces the AI’s brand voice.
  • Channel-Specific Adaptations: While maintaining consistency, the AI should adapt the tone and style based on the communication channel. For instance, emails might use a more formal tone compared to in-app notifications, while still adhering to the core writing guidelines.

13. Adaptability for Future Growth:​

  • Scalable Language Patterns: Guidelines should allow for scalable language patterns that can easily adapt to new features, updates, or AI capabilities. This ensures that the writing remains relevant and effective as the system evolves.
  • Continuous Improvement: Writing guidelines should encourage regular updates and reviews to keep pace with changes in technology, user expectations, and cultural trends. The AI should be able to adapt its communication style as these guidelines evolve.

These unique writing guidelines ensure that all AI-driven content is clear, user-centric, and adaptable, fostering a positive, trustworthy, and effective interaction between users and the AI system. By focusing on clarity, personalization, and adaptability, these guidelines help maximize the potential of AI in enhancing user communication and experience.