Skip to content

Comments

docs: add authoring agent instructions guide#286

Open
Paveltarno wants to merge 1 commit intomainfrom
docs/authoring-agent-instructions
Open

docs: add authoring agent instructions guide#286
Paveltarno wants to merge 1 commit intomainfrom
docs/authoring-agent-instructions

Conversation

@Paveltarno
Copy link
Collaborator

@Paveltarno Paveltarno commented Feb 22, 2026

Note

Description

This PR adds a new topic guide, docs/authoring-agent-instructions.md, covering best practices for writing Claude Code skills, CLAUDE.md project instructions, AGENTS.md files, and subagent definitions. The guide emphasizes token efficiency and progressive disclosure as core principles. A corresponding entry is added to docs/AGENTS.md to register the new guide in the project's topic index.

Related Issue

None

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Other (please describe):

Changes Made

  • Added docs/authoring-agent-instructions.md — new topic guide covering:
    • CLAUDE.md structure, what to include/exclude, and anti-patterns
    • Skill authoring (SKILL.md): frontmatter fields, body guidelines, progressive disclosure levels, bundled resource directory conventions, and description examples
    • Subagent definitions (.claude/agents/): format and a skills-vs-subagents comparison table
    • Pre-ship checklist for any instruction file
  • Updated docs/AGENTS.md to add the new guide to the topic guide index

Testing

  • I have tested these changes locally
  • I have added/updated tests as needed
  • All tests pass (npm test)

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have updated docs/ (AGENTS.md) if I made architectural changes

Additional Notes

None


🤖 Generated by Claude | 2026-02-22 00:00 UTC

Consolidates guidance for writing skills, CLAUDE.md, AGENTS.md, and subagent
definitions into a docs topic guide with progressive disclosure patterns.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/cli@0.0.33-pr.286.941c114

Prefer not to change any import paths? Install using npm alias so your code still imports base44:

npm i "base44@npm:@base44-preview/cli@0.0.33-pr.286.941c114"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "base44": "npm:@base44-preview/cli@0.0.33-pr.286.941c114"
  }
}

Preview published to npm registry — try new features instantly!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant