Improve LLM augmentation of user docs -

[lisa-tarbo]

Overview

Improve the ability for Claude to write more useful User Docs by:

1. Considering the current structure of the pages in menus
2. Ensuring that the "why" behind a feature/enhancement is documented
3. Keeping the pages shorter with tech notes and code moved to the Tech Hub
4. Checking if the concept note on the feature is still accurate after a feature is enhanced.

Background

Based on thinking on How to make good user docs

Approach

1. Each page should have a clear purpose and should avoid mixing these modes on one page. So we need to inform Claude about these types of pages

• Tutorials For helping a new user learn by doing.
• How-to guides For helping a user complete a specific task.
• Concepts For explaining how something works and why it matters.
• Tech Hub A reference for precise factual information such as advanced settings, example code or calling APIs.

2. Update the Claude agent instructions
   https://github.com/dimagi/open-chat-studio-docs/blob/main/.claude/agents/mkdocs-technical-writer.md

How to test

Run this manually and see if we can get Claude to:

• separate out email nodes tech details to Tech Hub
• improve the Tools concept page