Links

Live:             https://slides.com/mike-1/ux-writer-ai-agent/live

Later:             https://slides.com/mike-1/ux-writer-ai-agent/

HAL

2001

Principal Technical Writer

Product Documentation

Mission

• Complete accurate documentation ...

Pixabay CC0

https://slides.com/mike-1/ux-writer-ai-agent/

Background

Audience

• Writers
  • ​Content Designers
• UI Designers
• UI Developers
• Testers
• PMs
• Support and Sales
• Others

@TheMikeJang

Pixabay CC0

Content Design

We help users make decisions

https://slides.com/mike-1/ai-the-docs

We want to "unblock" users

Our style guides supply criteria

If AI were a teenager

• Teenagers

Mindset for AI

Fantasy Football

https://slides.com/mike-1/ux-writer-ai-agent/

Fantasy Football

Intimidation

Fantasy Football

No "right" answers 

Choices. Depends on situation.

Fantasy Football

https://slides.com/mike-1/ux-writer-ai-agent/

Fantasy football choices

https://slides.com/mike-1/ai-the-docs

Who should I start?

Better answer: it depends

Three tier model

How AI can help with content design

1.  Start with a style guide
2.  Set up instructions
3.  Build an AI Model
4.  Pull content from the style guide
5.  Organize the knowledge in AI
6.  Test the steps locally
7.  Identify problems
8.  Update the style guide
9.  Automate updates

Start with a Style Guide

• Designed for humans

• Content design skills for AI

Skills

• Well, sort of

• Well, sort of

• a reusable capability that can be invoked to perform a particular kind of task

Make it "easy" for ourselves

1.  Know your product
2. Set up instructions
3.  One easy breath
4.  Two thoughts
5.  Minimize need for docs
6.  Know your audience
7.  Know your stakeholders
8.  Start with the easy stuff
9.  Harder stuff: do your homework
10.  Use style guides (details)

-

-

-

-

-

-

-

-

-

-

-

-

https://slides.com/mike-1/ux-writer-ai-agent/

AI models -- Best practices

• Governing instructions
• Details in separate files

Searching the database

Make it "easy" for ourselves

• instructions.md

What we've done

• 30 different distinct pages

OMG AI

1.  Know your product
2. "Don't Make Me Think"
3.  Build a model
4.  Minimize need for docs
5.  Know your audience
6.  Know your stakeholders
7.  Start with the easy stuff
8.  Harder stuff: do your homework
9.  Use style guides (details)

-

-

-

-

-

-

-

-

-

-

-

Instructions & Skills

Organize for AI

Pixabay CC0

Format for AI

1.  Know your product
2. "Don't Make Me Think"
3.  One easy breath
4.  Pull content from your style guide

-

-

-

-

-

-

-

-

-

https://slides.com/mike-1/ux-writer-ai-agent/

Convert your style guide

• Format only

• Emerging standard for AI: Markdown

Conversion

HTML to Markdown

Writing for AI

1.  Know your product
2. "Don't Make Me Think"
3.  One easy breath
4.  Two thoughts
5.  Organize the knowledge for AI

-

-

-

-

-

-

-

-

-

-

Structure your instructions

• Straightforward set of steps

• Reference to a directory of "skills"

Before you deploy

1.  Know your product
2. "Don't Make Me Think"
3.  One easy breath
4.  Two thoughts
5.  Minimize need for docs
6.  Test steps locally
7.  Start with the easy stuff
8.  Harder stuff: do your homework
9.  Use style guides (details)

-

-

-

-

-

-

-

-

-

-

https://slides.com/mike-1/ux-writer-ai-agent/

Tip: pinned instructions

Formalize the Agent

Test time!

Avoid "hallucinations"

1.  Know your product
2. "Don't Make Me Think"
3.  One easy breath
4.  Two thoughts
5.  Minimize need for docs
6.  Know your audience
7.  Test edge cases

-

-

-

-

-

-

-

-

-

Test Time, Part 2

Big picture

Style guide

Instructions and Skills

AI

Agent

Style Guide

Instructions and Skills

AI Agent

Last minute addition

Last minute addition