/

/documentation-writer

846

Create or revise software documentation using the Diátaxis distinction between tutorials, how-to guides, reference, and explanation. Use for README sections, product and API documentation, operational guides, onboarding material, or restructuring an existing documentation set.

2 files
4.8 KB
MIT
Updated 2 months ago
GitHub
No alerts

Ask your Agent

Use this Skill: https://skilld.dev/gh/iflytek/skillhub/documentation-writer

This session only. Nothing lands on disk.

NOTICE.md

1.1 KB raw

≈272 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Third-Party Notice

Upstream project: github/awesome-copilot
Original source: skills/documentation-writer at be7a1cf734f427d50266335b461b86977299d953
Fixed upstream commit: be7a1cf734f427d50266335b461b86977299d953
Original author and maintainer: GitHub, Inc. and the awesome-copilot contributors
Original version: not declared in the upstream skill
Adapted version: 1.0.0
License: MIT; see LICENSE.txt

SkillHub contributors adapted the metadata and workflow, retained the four Diátaxis document types, removed the mandatory clarification and outline-approval pauses, allowed a complete one-pass result when context is sufficient, and added evidence, secret-handling, prompt-injection, and non-fabrication requirements.

The upstream project has not endorsed this adaptation. Diátaxis is referenced as a documentation framework; this package is not presented as an official Diátaxis publication.

Source: SKILL.md on GitHub

Third-party checks

No alerts1mo3 checks · Risk SAFE

Gen Agent Trust Hub1mo
The documentation-writer skill is a well-structured tool for generating software documentation. It includes robust defensive instructions to prevent prompt injection, secret exposure, and hallucination. No security risks were identified.
Socket1mo
No alerts
Snyk1mo
Risk: LOW · No issues

Provenance

Signed by skilld at 7885cc5. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last week.

Activeupdated 2 months ago

Capability

version: 1.0.0

/documentation-writer