一个智能体技能,将编码智能体充满术语、难以阅读的报告转化为清晰易懂的文档,使用了10条简明语言规则。

Stars

5

7 天增长

暂无数据

Fork 数

0

开放 Issue

0

开源协议

MIT

最近更新

2026-07-27

AI 仓库情报摘要
FR-AI / ANALYSIS

为什么值得关注

直接解决了AI生成内容“废话连篇”的普遍问题,通过具体的、可执行规则让自动化报告真正被人类理解,并附有前后对比示例。

适合谁使用

  • 使用Claude Code或其他AI编码智能体的开发者
  • 需要审阅AI生成报告和文档的团队负责人
  • 将智能体输出适配为更广泛受众阅读的技术文档写作者
  • 对AI过于冗长或技术化的文档感到困扰的任何人

典型使用场景

  • 从代码审查或审计中生成可读的分析报告
  • 创建人性化的错误报告和性能总结
  • 编写非技术人员也能理解的文档
  • 从智能体活动生成简洁的变更日志或发布说明

项目优势

  • 10条具体、可操作的写作规则,直接解决常见的可读性问题
  • 与Claude Code开箱即用,并可通过系统提示适配其他智能体
  • 包含了前后对比的示例,清晰展示了改进效果
  • 开源MIT许可证,积极接受贡献

使用前须知

  • 仅适用于面向人类的报告,不适用于需要内联精确代码引用的规范或计划
  • 需要智能体支持技能加载,对于非Claude的智能体需要手动插入规则
  • 效果取决于智能体是否始终如一地遵守这些规则

README 快速开始

human-readable-reports

Your coding agent writes reports that are technically correct and unreadable. Walls of jargon, file:line dumps, telegraphic bullets, invented terms. The team stops reading. This skill fixes that — deep content, easy reading.


The problem (you're not imagining it)

"AI verbosity" and "AI slop" are now common complaints — LLMs are trained to write long, thorough, hedged answers, so their reports default to something only the author's other agent could love. When the doc is unreadable, the human becomes the bottleneck.

The fix, in one look

Before — what an agent writes by default:

parseInput() is O(n²) due to nested scan (utils.js:88);
latency scales quadratically with list size → UI jank at scale.

After — same finding, with this skill:

The input parser gets slow as the list grows. It re-scans the whole list for each item, so a long list makes the screen stutter. (code location in the notes below)

Same facts. One of them your team will actually read.

The 10 rules

  1. Reader-first — write in their language, at their level.
  2. Point first — each section opens with the takeaway in one plain sentence.
  3. Analogy up front — ground the concept in something concrete.
  4. Full sentences, not fragments.
  5. Explain or drop jargon — no bare formulas, no coined terms.
  6. Evidence to the back — no file:line in the prose; put it in end-notes.
  7. Table cells read as phrases, not code.
  8. Cut the slop — no throat-clearing, no needless caveats.
  9. Progressive disclosure — hide depth behind expandable sections.
  10. Tone: teammate, not lecture.

Full rules, checklist, and the "when NOT to use it" boundary are in SKILL.md.

This README follows its own rules. That's the demo.

Install

Claude Code / Claude agents — clone into your skills directory:

# personal (all projects)
git clone https://github.com/SummerRiversound/human-readable-reports \
  ~/.claude/skills/human-readable-reports

# or project-shared
git clone https://github.com/SummerRiversound/human-readable-reports \
  .claude/skills/human-readable-reports

The agent loads it automatically when you ask for a report or analysis doc.

Cursor / other agents — paste the rules from SKILL.md into your system

项目描述

Agent skill: make AI-written analysis/report docs easy for humans to read and share (fights AI verbosity/slop).

相关仓库与替代方案

根据分类、Topic 和编程语言匹配的相似项目。

AgriciDaniel
精选
AgriciDaniel GitHub avatar

anti-slop

Anti-slop is a tool for detecting and repairing substance defects in AI-assisted prose, code, documentation, and agent output using deterministic scanners and structural procedures that produce verifiable artifacts rather than authorship judgments.

AI 与机器学习大语言模型
9
S40911120
精选
S40911120 GitHub avatar

recensa

Recensa is a self-hosted web viewer that indexes Claude Code session transcripts into a local SQLite database, enabling full-text search, replay, and audit of all past agent conversations without uploading data anywhere.

AI 与机器学习大语言模型
67
makecindy
精选
makecindy GitHub avatar

cindy

Cindy is an open-source AI agent that runs locally on your machine, integrates multiple AI harnesses and models, and provides memory, skills, and automation to perform real work in your projects and apps.

AI 与机器学习大语言模型
958