Writing for AI and RAG
The challenge: A section retrieved by an AI assistant can lose the context supplied by the surrounding page. Retrieval-augmented generation (RAG) makes that context important beyond the original reading experience.
My contribution: I created and primarily authored the internal guidance for writing documentation for AI retrieval, alongside contributions to the wider documentation style guide.
My approach: I defined guidance for self-contained sections, descriptive headings, explicit conditions, and consistent terminology, so a passage is designed to remain understandable on its own.
Reusable documentation frameworks
The challenge: Different solutions and page types need a consistent structure without treating every documentation task as the same kind of content.
My contribution: I authored the solutions documentation template and steering framework used in the team's shared AI-assisted authoring workflow.
My approach: I created reusable structures for overviews, how-to guides, setup, installation, and release notes, with guidance for content planning, evaluation, and naming conventions. Steering files give the AI writing and review instructions; their contents remain private.
Wren editorial tooling
The challenge: Generic language checks do not fully reflect a product's documentation standards or the needs of writers working in Markdown.
My contribution: I partnered with engineers on a custom VS Code editorial extension. I helped define the initial scope and functional requirements, led the functional testing strategy, and translated writer feedback into development priorities.
My approach: I connected style-guide requirements with the editing experience. This was a collaborative project: my role was documentation expertise, requirements, testing, and product coordination, not sole ownership of the engineering implementation.
Reporting automation
The challenge: Documentation work includes recurring reporting as well as writing and review.
My contribution: I authored an automation hook for a recurring documentation report within the team's shared tooling.
My approach: I made the reporting task repeatable through a defined workflow. Internal report contents, triggers, and implementation details are not included here.