Add documentation writer prompt #201
Merged
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.