structured-documentation

Writes categorized Findings, Feedback, and Conclusion markdown docs for workspace features.

Updated Jul 24, 2026
One-click install
npx skills add https://github.com/gweone/agent-plugins --skill structured-documentation-gweone
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: structured-documentation
Source: https://github.com/gweone/agent-plugins/tree/main/plugin/sharpps-work/skills/structured-documentation
Command: npx skills add https://github.com/gweone/agent-plugins --skill structured-documentation-gweone

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Investigation results, build decisions, and review feedback often live only in chat history or scattered notes, making them impossible to recover later. This Skill captures them as durable, version-controlled markdown records with a consistent structure. ## Core Features & Use Cases - Three-section template: Separates Findings (facts), Feedback (judgment), and Conclusion (decisions) so each doc stays scannable, with numbered findings cross-referenced by later sections. - Document conversion: Restructures existing files (research logs, notes, wikis) into the template, splitting multi-topic sources into one doc per topic. - Status tracking and indexing: Tracks Open/Pending/Needs decision/Resolved states with an Outstanding checklist, and maintains a README.md index of all docs under docs/structured-documentation/. - Confidentiality handling: Redacts secrets, sets a Confidentiality level, and confirms before committing sensitive content to git. - Use Case: After investigating a bug's root cause, ask to document the findings — the Skill drafts the structured doc, humanizes the prose, saves it to the repo, and updates the index. ## Quick Start Document what you found about the authentication module as a structured-documentation doc.

Frequently Asked Questions about structured-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document investigation findings in a reusable format?

Ask the agent to document what was found, and it drafts a markdown doc with numbered Findings, a Feedback section for judgment, and a Conclusion with the decision. The file is saved under docs/structured-documentation/ so it appears in git history like any other file.

How to convert an existing notes file into structured documentation?

Point the Skill at the existing file and it reads the content, then rewrites the actual substance into the Findings/Feedback/Conclusion template. A file covering many topics is split into one doc per topic rather than forced into a single document.

Where are structured documentation files saved?

Docs are saved as markdown under docs/structured-documentation/ in the current workspace, never in a temp directory. A README.md index in that folder tracks every doc's Status and outstanding item count.

Can I track unresolved items across multiple documentation files?

Yes. Each doc has a Status field (Open, Pending, Needs decision, Resolved) and an Outstanding checklist. The shared README.md index lists every doc with its status and unchecked-item count so a fresh session can resume open work.

How does it handle secrets or confidential content in docs?

Secrets and credentials are never pasted in full — they are described by location or redacted. Each doc gets a Confidentiality level (Public, Internal, Confidential), and the Skill asks for confirmation before saving inherently sensitive findings to a repository.

When should I not use structured documentation?

It is not meant for polished external deliverables or quick answers that only need to be stated in chat. For shareable documents, pair the content with a Word generation skill instead of treating this format as the final output.