Slopdocs

v1.0.1工具与命令

slopdocs

OpenCode plugin and agent skill for the slopdocs documentation convention.

维护活跃

#opencode #opencode-plugin #agent #skill #slopdocs #documentation

GitHub 仓库 npm 页面官方主页

GitHub 星标

月装机量

近 7 天 3

综合评分SCORE

21.5

生态多维模型

快速安装与配置

opencode.json

写入当前项目的 opencode.json，只对这个仓库生效。

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "plugin": ["slopdocs@1.0.1"]
}

opencode 启动时会通过内嵌运行时自动加载 npm 依赖并缓存至本地目录，无需手动在全局环境执行安装。

README.md

查看原始文件→

An agent skill for the slopdocs convention. Teaches your coding agent to keep its planning docs, bug investigations, and feature write-ups in your repo where the next agent can find them.

Install (OpenCode)

Add to your opencode.json:

{
  "plugin": ["slopdocs"]
}

Restart OpenCode. The slopdocs skill is now available and will be loaded automatically when the agent is writing or deciding whether to create documentation.

To track an unreleased version directly from the repo, install from git instead:

{
  "plugin": ["slopdocs@git+https://github.com/ryanskidmore/slopdocs.git"]
}

Manual install

Copy skills/slopdocs/SKILL.md into your project:

.opencode/skills/slopdocs/SKILL.md

Or for cross-tool compatibility:

.agents/skills/slopdocs/SKILL.md

What it does

The skill teaches your agent the slopdocs convention:

slopdocs/features/ - one living doc per feature
slopdocs/bugs/ - date-prefixed bug investigations
slopdocs/plans/ - date-prefixed implementation plans

It also tells the agent when a doc is worth writing (architectural decisions, non-obvious bugs, new features) and when to skip (renames, trivial changes, dependency bumps).

License

MIT