AI Preferences

Make every AI generator follow your team's writing style, terminology, and structure.

What are AI Preferences?

AI Preferences let you set custom guidelines and documentation templates that shape how DocuWriter.ai writes your documentation. Instead of editing every generated page after the fact, you tell the AI upfront how you want things written.

Your preferences are applied automatically to every generator you select, such as Full Tree Documentation, Repository Sync suggestions, Code Documentation, and more.

Where to find it

Go to Settings > AI preferences in the sidebar.

Using the Platform AI Agent with AI Preferences

The Platform AI Agent can help you decide what to put in your guidelines and template.

Examples:

  • "Help me write AI Preferences for API documentation"
  • "What guidelines should I use for a junior developer audience?"
  • "Draft a documentation template for onboarding docs"
  • "Explain which generators should use these preferences"

After the assistant helps you draft or refine the text, review it and save it from Settings > AI preferences.

Team-wide preferences, file uploads, and generator selection are controlled from the settings page so you can review exactly what will apply before saving.

Guidelines

Guidelines are short rules or style notes that the AI follows when generating documentation. Think of them like a style guide for generated docs.

Examples of useful guidelines:

  • "Always include code examples for every public method"
  • "Write for a junior developer audience"
  • "Use British English spelling"
  • "Never mention internal class names in end-user documentation"
  • "Include a Troubleshooting section at the end of every page"

You can type your guidelines directly or upload a .md or .txt file. Uploads are limited to 50 KB, and saved guideline text is applied up to 4,000 characters.

Documentation template

The template is a Markdown structure that guides how generated pages are organized. It defines the sections and headings you want every page to follow.

For example, if your team always expects an Overview, Architecture, API Reference, Examples, and FAQ structure, set that as your template and every generated page will follow it.

You can type your template directly or upload a .md or .txt file. Uploads are limited to 50 KB, and saved template text is applied up to 12,000 characters.

The template acts as guidance, not a rigid constraint. The AI may adapt slightly if the source code does not fit every section, but the overall structure will follow your template closely.

Choose which generators use your preferences

Not every generator needs the same treatment. Use the Apply to generators multi-select to pick exactly which generators receive your guidelines and template.

By default, the most common generators are selected:

  • Full Tree Documentation
  • Code Documentation
  • Codebase Documentation
  • Release Notes
  • Repository Sync Suggestions
  • PR Changes Summary

You can add or remove generators at any time.

Team settings

If you are a team owner, you can enforce your AI preferences for all team members.

  • Toggle Force team members to use these settings to apply your guidelines and template to every generation by any team member.
  • Team members see a read-only view with a badge indicating they are using the team owner's settings.

This keeps documentation style consistent across your team without everyone configuring their own preferences.

Tips

  • Keep guidelines short and specific: a few focused rules work better than a long essay.
  • Use the template for structure: let guidelines handle tone, style, and formatting rules.
  • Test with a small generation first: generate one page to see how your preferences affect the output before running a full documentation build.
  • Review team-wide changes before saving: enforced team preferences affect other users' future generations.

Need help?

Open the in-app chat or email [email protected].