Skip to content

Standards

This section contains recommended practices and guidelines for consistent operations.

What Goes Here

Standards are "Should Do" guidelines that define: - Best practices - Coding conventions - Documentation formats - Workflow recommendations - Tool usage guidelines

Key Standards

Creating New Standards

When creating a new standard: 1. Use kebab-case filenames (e.g., api-design-standard.md) 2. Include frontmatter with: title, created date, status 3. Provide clear examples and rationale 4. Explain when exceptions are acceptable

Standard vs. Policy

  • Standard (this section): "We recommend using REST for public APIs"
  • Policy (../policies/): "All public APIs must use HTTPS"