Docs Standards

Keeps scenario README files and session docs aligned with the repo's documentation conventions.

Azure-Samples 46cc7e6 991 B Updated

File contents

Context

Use this skill when adding or editing scenario READMEs, session documentation, or docs that need to explain architecture and deployment flows.

Patterns

  • State what the scenario demonstrates.
  • Explicitly name the scenario it was derived from and why.
  • Include prerequisites, configuration, run steps, expected output, and troubleshooting.
  • Link back to shared session docs when the scenario supports a larger story.

Examples

  • Scenario 09 now calls out that it is derived from Scenario 01 - Semantic Search.
  • Scenario docs include a session-docs backlink so readers can move from the implementation to the presentation material.

Anti-Patterns

  • Leaving the source scenario implicit.
  • Documenting only screenshots without setup or troubleshooting.
  • Splitting the story across docs without a backlink to the session package.

azure-samples/eshoplite/tree/main/.squad/skills/docs-standards commit 46cc7e6010

Frequently asked questions

npx skillmds@latest add azure-samples/docs-standards