Skip to main content

Feature Update Template

Duplicate this file for every new feature or notable change and store it as docs/shared/releases/<date>-<slug>.md. Link the final version from the indexes in docs/user/ and docs/llm/.

Documentation Deliverables​

  • Produce a dedicated user-facing article by cloning docs/user/update-template.md; do not mix audience content in this master file.
  • Produce a dedicated LLM brief by cloning docs/llm/update-template.md.
  • Add or update shared references (glossaries, naming rules, style decisions) under docs/shared/ so all audiences stay aligned.
  • Cross-link the three deliverables, but keep their content scoped to the intended audience.

End-User Impact (Help Center)​

What changes and why it matters​

  • Describe the benefit for end users in direct, plain language.
  • Note whether it replaces an existing flow or introduces new steps.

Content updates​

  • Articles to create or update: path within docs/user/.
  • Navigation changes: menus, breadcrumbs, search entries.
  • Media assets: screenshots, GIFs, videos (location under assets/).
  • FAQs / Callouts: common questions, warnings, or limitations.

LLM Guidance​

  • Essential context: facts or constraints the model must respect.
  • Tone / response instructions: sample phrasing or style guidelines.
  • Structured data: parameters, command names, IDs, endpoints.
  • Prompt examples: 
    User: <scenario>
    Assistant: <correct response>
  • Tools or actions available: note changes to chains, functions, or internal APIs.

Technical Details​

  • Repositories / modules affected: include paths and links to PRs.
  • Interfaces and contracts: endpoints, schemas, events, feature flags.
  • Dependencies: toggles, migrations, third-party integrations.
  • Implementation notes: key decisions, known risks, fallback plan.

Validation and Testing​

  • Manual tests: critical scenarios with steps and expected outcomes.
  • Automated tests: suites or commands to run (npm test, pytest, etc.).
  • Post-release metrics: dashboards, alerts, logs to monitor.
  • QA checklist:
    • Happy paths and edge cases verified
    • Localization / translations reviewed
    • Accessibility validated (when applicable)

Launch Checklist​

  • User-facing documentation approved and published
  • Corresponding section in docs/llm/ updated
  • Internal release notes shared (Slack / Email)
  • Feature flag or toggle documented with current state
  • Support tooling updated (Zendesk, Intercom, etc.)

History and Follow-Up​

  • Tickets / issues: references to Jira, Linear, GitHub, etc.
  • Related pull requests:
  • Owners: PM, technical writer, dev owner, support contact.
  • Pending feedback: open bugs, enhancement requests, user insights.

When the documentation is complete, update the master index in docs/shared/releases.md (create it if it does not yet exist) and link the end-user (docs/user/) and LLM (docs/llm/) versions to maintain full traceability across audiences.