Skip to content

TEMPLATE.md

Latest commit

 

History

History
129 lines (93 loc) · 4.01 KB

TEMPLATE.md

File metadata and controls

129 lines (93 loc) · 4.01 KB
Raw
title Clear task-based title using the feature name
description A short description of the page's content. This is used for SEO purposes.
keywords
how to primary task
feature name
related task phrases
internalScope Audience is [who this doc is for]. Covers [single clearly defined workflow], does not cover [closely related workflows intentionally excluded].

[This must match the article title exactly]

Briefly explain:

  • What this feature does
  • Why someone would use it
  • The outcome they can expect
  • Any important limitations

Keep this concise and benefit-focused.

Who can use [exact feature name]

Clearly state:

  • Required role (Workspace Admin, Member, Domain Admin, etc.)
  • Plan limitations (Free, Collect, Control, Track, Submit, Annual Subscription, pay-per-use)
  • Any permission or Workspace setting prerequisites

If this feature depends on another setting: If [the required setting] is not enabled, learn how to enable . If [the required setting] is not enabled, learn how to enable [Dependency Feature]. State explicitly if: This feature is not available on mobile.

How to [complete primary task using exact feature name]

  1. Go to Settings > Workspaces > Workspace Name > [Section Name].
  2. Click [Exact button name in Sentence case].
  3. Configure the required settings.
  4. Click Save or final action button (for example, Submit, Confirm).

ADD A SCREENSHOT HERE.
Suggestion: Show the full page with the relevant section highlighted.

What happens after you [complete primary task using exact feature name]

Explain:

  • System behavior
  • Notifications triggered
  • Approval or reimbursement impact
  • Sync behavior (if applicable)
  • Billing impact (if applicable)

Be explicit. Avoid vague phrasing.

FAQ

Can members [Common Task Variation Using Feature Name]?

Clear direct answer.

Why can’t I see [Feature Name]?

Explain possible causes:

  • You’re not a Workspace Admin or Workspace Owner
  • The feature is not included in your plan
  • The Workspace setting is disabled
  • Domain-level restrictions apply

Does [Feature Name] work with [Integration or Related Feature]?

Provide a precise compatibility explanation.

How do I troubleshoot issues with [Feature Name]?

Include only lightweight troubleshooting. If complex troubleshooting is required, link to a separate dedicated article.