feat: enhance Explanation template with question-driven investigation methodology #15
Conversation
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
Signed-off-by: Gavin Didrichsen <[email protected]>
Signed-off-by: Gavin Didrichsen <[email protected]>
- Add "How was this investigated?" sections to guide research transparency - Include prompts for specific evidence, file paths, and discovery process - Add dedicated Testing Example section with code and instructions - Encourage progressive investigation flow between questions - Template now produces educational explanations that show methodology Signed-off-by: Gavin Didrichsen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Enhanced the Diátaxis explanation template to include investigation methodology and research transparency, based on the successful pattern developed with some of my current work.
Changes
Template Improvements
Benefits
This enhancement makes explanation documents both educational and practical, teaching readers how to investigate similar questions while providing concrete