Add documentation writer prompt#201
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new prompt file that creates a documentation writing assistant based on the Diátaxis framework, designed to help developers create structured, high-quality technical documentation.
- Introduces a documentation expert prompt that follows the Diátaxis methodology for creating tutorials, how-to guides, reference materials, and explanations
- Implements a structured workflow that ensures proper document planning and user needs assessment before content creation
- Updates the README to include the new prompt in the available templates list
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| prompts/documentation-writer.prompt.md | New prompt file implementing a Diátaxis-based documentation writing assistant with structured workflow and clear principles |
| README.md | Added entry for the new documentation writer prompt in the prompts table |
aaronpowell
approved these changes
Aug 19, 2025
iletai
pushed a commit
to iletai/awesome-copilot
that referenced
this pull request
Sep 3, 2025
* Add documentation writer prompt * review: explicitly define the minimum-required tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
node update-readme.jsand verified thatREADME.mdis up to date.Description
Adds a new prompt which turns the agent into an expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework (see: https://diataxis.fr/)
Type of Contribution
Additional Notes
Here are some screenshots of a small example:
Mind that the prompt file was initially named "documentation-expert.prompt.md", but then I renamed it to "documentation-writer.prompt.md" (right before opening this PR)
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.