reporting

Guidelines for formatting reports using HTML details/summary tags

4,265 stars

Best use case

reporting is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Guidelines for formatting reports using HTML details/summary tags

Teams using reporting should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/reporting/SKILL.md --create-dirs "https://raw.githubusercontent.com/github/gh-aw/main/skills/reporting/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/reporting/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How reporting Compares

Feature / AgentreportingStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Guidelines for formatting reports using HTML details/summary tags

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

SKILL.md Source

# Report Format Guidelines

This skill provides guidelines for formatting reports with collapsible sections.

## Use HTML Details/Summary Tags

To prevent excessive scrolling and improve readability, **wrap your reports in HTML `<details>` and `<summary>` tags**. This allows users to expand and collapse sections as needed.

**Basic Structure:**

```markdown
<details>
<summary>📊 Report Title - [Date]</summary>

## Report Content

Your detailed report content goes here...

### Section 1

Content for section 1...

### Section 2

Content for section 2...

</details>
```