Guides Squad documentation writing and review using Microsoft Style Guide rules and project conventions. It covers clear English, consistent page structure, practical examples near the top, and matching test updates when documentation pages are added.
한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.
Microsoft Style Guide + Squad-specific documentation patterns
설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.
Squad documentation follows the Microsoft Style Guide with Squad-specific conventions. Consistency across docs builds trust and improves discoverability.
features/, scenarios/, guides/, update corresponding EXPECTED_* arrays in test/docs-build.test.ts in the same commit✓ Correct:
# Getting started with Squad
> ⚠️ **Experimental:** This feature is in preview.
Try this:
\`\`\`bash
squad init
\`\`\`
Squad helps you build AI teams...
---
## Install Squad
Run the following command...
✗ Incorrect:
# Getting Started With Squad // Title case
Squad is a tool which will help users... // Third person, future tense
You can install Squad with npm & configure it... // Ampersand in prose
아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.
로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.
아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.
Coordinate work across AI agents with shared rules for locating team files, recording decisions and their reasons, and requesting help. It also defines who owns revisions after a reviewer rejects an artifact.
한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.
Set shared development rules for an agent team: keep specific agent names out of product code, tests, and CI configuration, verify affected tests before finishing, and record lessons learned from mistakes.
한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.
Routes requests to design, create, update, debug, or upgrade GitHub Agentic Workflows to the appropriate instructions. It helps the agent select a workflow-specific procedure and apply any additional rules defined for the repository.
한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.
Prepare architecture proposals before implementation so the team can agree on a direction. Organize evidence, technical choices, effects on existing work, risks, and the first release’s scope into a document with clear recommendations and decision owners.
한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.
Update the gh-aw-firewall version used by gh-aw, rebuild generated files, and review release notes and configuration schemas, which define valid settings. It guides related code and test updates while identifying follow-up work that remains.
한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.
Review git and gh operations in gh-aw workflows to check credential availability for each repository. Identify missing token handoffs, risky expansions of limited checkouts, and error handling needed where credentials are intentionally unavailable.
한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.