agentsclimarketplace

Dual surface docs drift

Skill fabioc-aloha/Alex_Skill_Mall/plugins/documentation/dual-surface-docs-drift

Two READMEs covering overlapping scope will diverge:From its SKILL.md

Install
npx -y skills add fabioc-aloha/Alex_Skill_Mall --skill dual-surface-docs-drift

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 4 stars4 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

2.0 KB, 398 tokens by cl100k_base, as published. Nobody here has run it

Dual-Surface Docs Drift

The Problem

Two READMEs covering overlapping scope will diverge:

  • Root README describes feature X
  • Wiki page also describes feature X
  • One gets updated, the other doesn't

The Solution

Option 1: Cross-Reference (Preferred)

The less-detailed doc points to the more-detailed:

<!-- README.md (brief) -->
## Configuration

For basic setup, set `API_KEY` in your environment.

For advanced configuration options, see the 
[Configuration Guide](https://github.com/org/repo/wiki/Configuration).
<!-- wiki/Configuration.md (detailed) -->
## Configuration

Complete reference for all configuration options...

Option 2: Consolidate

If both documents serve the same audience, merge them:

<!-- Keep ONE source, delete or redirect the other -->
## Configuration

[Full content here, single location]

Option 3: Audience Separation

If audiences differ, make the separation explicit:

<!-- README.md header -->
> **Developer docs**: This README is for contributors.
> **User docs**: See the [Wiki](./wiki) for end-user documentation.

Decision Table

README AudienceWiki AudienceAction
DevelopersDevelopersConsolidate
DevelopersEnd usersSeparate + cross-ref
End usersEnd usersConsolidate

Verification

Search for duplicated headers:

# Find potential overlaps
grep -h "^##" README.md wiki/*.md | sort | uniq -d

If the same H2 appears in both, you have drift risk.

When to Apply

  • Adding documentation to an existing repo
  • Noticing outdated info in one of two places
  • Documentation audit

Tags

documentation drift maintenance wiki

Keep looking

Skills are one crate of 326,736. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.