Inputs
- •$TECHNICAL_DOMAIN: the technical domain to which the package belongs (e.g., "orchestration", "monitoring", "infrastructure-as-code", etc.)
- •$PACKAGE_NAME: name of the package, technology, tool, or pattern for which usage rules are being created
- •$AGENTS: list of agents that will make use of the tool
Goal
Create a comprehensive set of rules for the specified package/technology/tool/pattern.
Operating constraints
- •MUST follow domain management
- •Write a
markdownfile in a condensed format that would be useful for agents to work with your tool. - •MANDATORY: aggressively prune and edit it for clarity, conciseness, and relevance.
- •MANDATORY: use Ash Framework's usage-rules.md as a reference example.
- •The files are always written to the
docs/rules/[$TECHNICAL_DOMAIN]/[$PACKAGE_NAME].mdandrules/[$TECHNICAL_DOMAIN]/[PACKAGE_NAME]/[domain].mdpaths - •Once a file is created, update the relevant agent specifications (from the
$AGENTSlist) to include a link to the usage rules in the format specified below.
markdown
<!-- [$PACKAGE_NAME]-start --> ## [$PACKAGE_NAME] usage _A tool for [summary of reason the tool is adopted]._ [[$PROJECT_NAME] usage rules](rules/[$DOMAIN]/[$PROJECT_NAME].md) <!-- [$PACKAGE_NAME]-end -->