ringwriting-functional-docs

Writing Functional Documentation

Functional documentation explains concepts, guides users through workflows, and helps them understand "why" and "how" things work. This differs from API reference, which documents "what" each endpoint does.

Document Types

Writing Patterns

Lead with Value

Start every document with what the reader will learn or accomplish.

✅ This guide shows you how to create your first transaction in under 5 minutes.

❌ In this document, we will discuss the various aspects of transaction creation.

Use Second Person

Address the reader directly.

✅ You can create as many accounts as your structure demands.

❌ Users can create as many accounts as their structure demands.

Present Tense

Use for current behavior.

✅ Midaz uses a microservices architecture.

❌ Midaz will use a microservices architecture.

Action-Oriented Headings

Indicate what the section covers or what users will do.

✅ Creating your first account

❌ Account creation process overview

Short Paragraphs

2-3 sentences maximum. Use bullets for lists.

Visual Elements

Section Dividers

Use --- to separate major sections. Improves scannability.

Linking Patterns

• Internal links: Link concepts when first mentioned: "Each Account is linked to a single Asset"
• API reference links: Connect to API docs: "Manage via API or Console"
• Next steps: End guides with clear next steps

Quality Checklist

• Leads with clear value statement
• Uses second person ("you")
• Uses present tense
• Headings are action-oriented (sentence case)
• Paragraphs are short (2-3 sentences)
• Includes working code examples
• Links to related documentation
• Ends with next steps
• Follows voice and tone guidelines