GPTsApp Skillscommunity example · Use or study
documentation-writer
Choose the right kind of software documentation and agree its outline before drafting.
github/awesome-copilotskills/documentation-writer/SKILL.md
Before you use it
- Input
- Target audience, reader goal, included and excluded topics, document type and any approved existing documentation for context.
- Expected output
- A proposed outline followed, after approval, by a Markdown draft shaped as a tutorial, how-to guide, reference or explanation.
- Prerequisites
- Provide a concrete reader task and review the outline first. Technical claims and examples still need verification against your project. The source limits external research to links the user explicitly authorizes; this directory performs no document generation.
Client setup and runtime behavior are not verified here; client installation is not individually established. The use notes below describe source preparation, inputs and limits.
Publisher documentation, static file observations and environment tests are different kinds of evidence. Runtime behavior has not been observed.
Use this method
Source-based preparation, not an installation or a completed run. Nothing is executed here.
- Good fit for
- Structuring a specific software document when its reader, purpose and review boundary can be made explicit.
- Not for / limits
- Not automatic repository discovery, unrestricted web research or a guarantee that generated code samples are correct. No host installation or runtime behavior has been verified.
- Prepare
- Describe one reader goal, the audience and scope; select the document type that serves that goal.
- Apply
- Review the proposed outline and explicitly approve it before moving to a full draft; supply only the source material authorized for that task.
- Check
- Check the resulting Markdown for task completion, consistency with existing terms and independently supported technical examples.
Sources read for this note
These exact files were read as text at the displayed commit. Other files and external tools were not reviewed. A repository LICENSE observation does not confirm Skill-specific applicability or dependency rights.
- skills/documentation-writer/SKILL.md ↗
Read 2026-09-10T10:33:30.717Z
7e8244988c9f4eb63bf8c0edf160578544621eb96e5e51e2d848f1401c5de8f1 - LICENSE ↗
Read 2026-09-10T10:33:31.265Z
e32449d23085399adc1222f7a17408b730550258e51627c153cb108ca9955823
Study the method
Compare the four document purposes and the outline-approval boundary. Examine how audience, task and exclusions keep a document from mixing a lesson, reference and troubleshooting guide without a clear goal.
File and folder counts are unknown, not zero.
The supporting file list has not been read for this source. Open the source directory to inspect it.
Zero files in scripts/ does not mean no execution, network access or file writes. Markdown and other folders may describe or contain executable behavior.
Source version and requirements
- Observed
- 2026-09-08T11:55:57.465Z
- Source commit
- f38fb6cf039b835990d0f49dc161d7c2af99ef69
- Content SHA-256
- 7e8244988c9f4eb63bf8c0edf160578544621eb96e5e51e2d848f1401c5de8f1
- License
- Unknown
- Author attribution
- Repository owner: github. Individual authorship is not independently established.
This page describes a pinned source snapshot, not the latest repository state. Changes after this commit have not been reconciled here. A repository license does not necessarily cover external models, datasets or services.
Open current repository ↗