@mytechtoday/augment-extensions 0.7.0 → 1.2.0

package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md

@@ -1,334 +1,334 @@
-# Screenplay Quality Review Checklist
-
-## Overview
-
-Comprehensive quality review checklist for screenplay module content validation.
-
----
-
-## Module Structure Review
-
-### File Organization
-
-- [ ] All required directories present (rules/, examples/, schemas/)
-- [ ] Files properly named (kebab-case)
-- [ ] No duplicate content across files
-- [ ] Logical organization and grouping
-
-### Documentation Completeness
-
-- [ ] README.md is comprehensive
-- [ ] module.json has accurate metadata
-- [ ] All rule files are complete
-- [ ] All examples are functional
-- [ ] All schemas are valid JSON
-
----
-
-## Content Quality Review
-
-### Rule Files
-
-**Universal Formatting (universal-formatting.md):**
-- [ ] AMPAS standards accurately documented
-- [ ] Clear examples provided
-- [ ] Common mistakes addressed
-- [ ] Best practices included
-
-**Category-Specific Rules:**
-- [ ] AAA Hollywood Films (aaa-hollywood-films.md)
-- [ ] Independent Films (independent-films.md)
-- [ ] TV Series (tv-series.md)
-- [ ] Streaming Content (streaming-content.md)
-- [ ] Live TV Productions (live-tv-productions.md)
-- [ ] News Broadcasts (news-broadcasts.md)
-- [ ] Commercials (commercials.md)
-- [ ] Web Content (web-content.md)
-
-**Each category file should have:**
-- [ ] Clear definition of category
-- [ ] Specific formatting requirements
-- [ ] Pacing and structure guidelines
-- [ ] Examples
-- [ ] Best practices
-- [ ] Common pitfalls
-
-**Supporting Rules:**
-- [ ] Character Development (character-development.md)
-- [ ] Dialogue Writing (dialogue-writing.md)
-- [ ] Narrative Structures (narrative-structures.md)
-- [ ] Pacing and Timing (pacing-timing.md)
-- [ ] Screen Continuity (screen-continuity.md)
-- [ ] Diversity and Inclusion (diversity-inclusion.md)
-
----
-
-## Schema Validation
-
-### JSON Schema Files
-
-**character-profile.json:**
-- [ ] Valid JSON syntax
-- [ ] All required fields defined
-- [ ] Appropriate data types
-- [ ] Clear descriptions
-- [ ] Comprehensive coverage
-
-**beat-sheet.json:**
-- [ ] Save the Cat structure complete
-- [ ] All 15 beats included
-- [ ] Page number ranges appropriate
-- [ ] Clear descriptions
-
-**plot-outline.json:**
-- [ ] Three-act structure supported
-- [ ] Sequences and scenes defined
-- [ ] Turning points included
-- [ ] Flexible and comprehensive
-
-**trope-inventory.json:**
-- [ ] Trope categories comprehensive
-- [ ] Usage types defined
-- [ ] Cliché warnings included
-- [ ] Subversion strategies supported
-
-**screenplay-config.json:**
-- [ ] All configuration options included
-- [ ] Appropriate defaults
-- [ ] Clear descriptions
-- [ ] Tool integration options
-
----
-
-## Example Files Review
-
-### Fountain Examples
-
-**aaa-hollywood-scene.fountain:**
-- [ ] Proper Fountain syntax
-- [ ] Demonstrates AAA Hollywood style
-- [ ] High-stakes action
-- [ ] Visual spectacle
-- [ ] Proper formatting
-
-**independent-monologue.fountain:**
-- [ ] Proper Fountain syntax
-- [ ] Character-driven
-- [ ] Emotional depth
-- [ ] Natural dialogue
-- [ ] Proper formatting
-
-**tv-episode-teaser.fountain:**
-- [ ] Proper Fountain syntax
-- [ ] Cliffhanger structure
-- [ ] Appropriate length
-- [ ] Engaging hook
-- [ ] Proper formatting
-
-**news-segment.fountain:**
-- [ ] Proper broadcast format
-- [ ] Timing marks included
-- [ ] B-roll notes
-- [ ] Production notes
-- [ ] Proper formatting
-
-**commercial-30sec.fountain:**
-- [ ] Proper commercial format
-- [ ] Timing breakdown
-- [ ] Call-to-action
-- [ ] Production notes
-- [ ] Proper formatting
-
-### YAML Examples
-
-**character-profile-example.yaml:**
-- [ ] Valid YAML syntax
-- [ ] Demonstrates schema usage
-- [ ] Comprehensive character data
-- [ ] Clear and detailed
-- [ ] Follows schema structure
-
-**beat-sheet-example.yaml:**
-- [ ] Valid YAML syntax
-- [ ] All 15 beats included
-- [ ] Demonstrates Save the Cat structure
-- [ ] Clear and detailed
-- [ ] Follows schema structure
-
-**plot-outline-example.yaml:**
-- [ ] Valid YAML syntax
-- [ ] Three-act structure
-- [ ] Sequences and scenes
-- [ ] Clear and detailed
-- [ ] Follows schema structure
-
----
-
-## Integration Documentation Review
-
-### VS Code Integration (vscode-integration.md)
-
-- [ ] Better Fountain setup instructions
-- [ ] Configuration examples
-- [ ] Keyboard shortcuts
-- [ ] Export workflow
-- [ ] Troubleshooting section
-- [ ] Tips and best practices
-
-### Fountain Format (fountain-format.md)
-
-- [ ] Complete syntax reference
-- [ ] All elements covered
-- [ ] Clear examples
-- [ ] Best practices
-- [ ] Common mistakes
-- [ ] Conversion tools listed
-
-### AI Integration Testing (ai-integration-testing.md)
-
-- [ ] Testing checklist complete
-- [ ] Category-specific validation
-- [ ] Before/after examples
-- [ ] Common AI mistakes documented
-- [ ] Validation tools listed
-- [ ] Quality metrics defined
-
-### Formatting Validation (formatting-validation.md)
-
-- [ ] AMPAS standards documented
-- [ ] Element specifications complete
-- [ ] Validation checklist comprehensive
-- [ ] Common errors documented
-- [ ] Automated tools listed
-
----
-
-## Consistency Review
-
-### Terminology
-
-- [ ] Consistent use of terms across all files
-- [ ] Industry-standard terminology
-- [ ] Clear definitions where needed
-
-### Formatting
-
-- [ ] Consistent markdown formatting
-- [ ] Consistent code block styling
-- [ ] Consistent heading hierarchy
-- [ ] Consistent list formatting
-
-### Examples
-
-- [ ] Examples are consistent with rules
-- [ ] Examples demonstrate best practices
-- [ ] Examples are realistic and practical
-
----
-
-## Accuracy Review
-
-### Industry Standards
-
-- [ ] AMPAS standards accurately represented
-- [ ] BBC standards (if mentioned) accurate
-- [ ] Industry terminology correct
-- [ ] Page count guidelines accurate
-
-### Technical Accuracy
-
-- [ ] JSON schemas are valid
-- [ ] YAML examples are valid
-- [ ] Fountain syntax is correct
-- [ ] Code examples work as intended
-
-### Best Practices
-
-- [ ] Recommendations align with industry standards
-- [ ] Best practices are current and relevant
-- [ ] Advice is practical and actionable
-
----
-
-## Completeness Review
-
-### Coverage
-
-- [ ] All screenplay categories covered
-- [ ] All major formatting elements documented
-- [ ] All common scenarios addressed
-- [ ] Sufficient examples provided
-
-### Gaps
-
-- [ ] No missing critical information
-- [ ] No broken references
-- [ ] No incomplete sections
-- [ ] No placeholder content
-
----
-
-## Usability Review
-
-### Clarity
-
-- [ ] Instructions are clear and easy to follow
-- [ ] Examples are helpful and illustrative
-- [ ] Technical terms are explained
-- [ ] Organization is logical
-
-### Accessibility
-
-- [ ] Content is well-organized
-- [ ] Navigation is intuitive
-- [ ] Search-friendly structure
-- [ ] Appropriate level of detail
-
----
-
-## Final Validation
-
-### Module Metadata
-
-- [ ] module.json version is correct
-- [ ] Character count is accurate
-- [ ] Description is accurate
-- [ ] All metadata fields complete
-
-### README
-
-- [ ] Comprehensive overview
-- [ ] Clear installation instructions
-- [ ] Directory structure documented
-- [ ] Contents listing complete
-- [ ] Character count included
-
-### Quality Standards
-
-- [ ] Professional quality throughout
-- [ ] No typos or grammatical errors
-- [ ] Consistent voice and tone
-- [ ] Ready for production use
-
----
-
-## Issues Identified
-
-**Critical Issues:**
-- (List any critical issues found)
-
-**Minor Issues:**
-- (List any minor issues found)
-
-**Recommendations:**
-- (List any recommendations for improvement)
-
----
-
-## Sign-Off
-
-**Reviewer:** _________________
-**Date:** _________________
-**Status:** [ ] Approved [ ] Needs Revision
-**Notes:** _________________
-
+# Screenplay Quality Review Checklist
+
+## Overview
+
+Comprehensive quality review checklist for screenplay module content validation.
+
+---
+
+## Module Structure Review
+
+### File Organization
+
+- [ ] All required directories present (rules/, examples/, schemas/)
+- [ ] Files properly named (kebab-case)
+- [ ] No duplicate content across files
+- [ ] Logical organization and grouping
+
+### Documentation Completeness
+
+- [ ] README.md is comprehensive
+- [ ] module.json has accurate metadata
+- [ ] All rule files are complete
+- [ ] All examples are functional
+- [ ] All schemas are valid JSON
+
+---
+
+## Content Quality Review
+
+### Rule Files
+
+**Universal Formatting (universal-formatting.md):**
+- [ ] AMPAS standards accurately documented
+- [ ] Clear examples provided
+- [ ] Common mistakes addressed
+- [ ] Best practices included
+
+**Category-Specific Rules:**
+- [ ] AAA Hollywood Films (aaa-hollywood-films.md)
+- [ ] Independent Films (independent-films.md)
+- [ ] TV Series (tv-series.md)
+- [ ] Streaming Content (streaming-content.md)
+- [ ] Live TV Productions (live-tv-productions.md)
+- [ ] News Broadcasts (news-broadcasts.md)
+- [ ] Commercials (commercials.md)
+- [ ] Web Content (web-content.md)
+
+**Each category file should have:**
+- [ ] Clear definition of category
+- [ ] Specific formatting requirements
+- [ ] Pacing and structure guidelines
+- [ ] Examples
+- [ ] Best practices
+- [ ] Common pitfalls
+
+**Supporting Rules:**
+- [ ] Character Development (character-development.md)
+- [ ] Dialogue Writing (dialogue-writing.md)
+- [ ] Narrative Structures (narrative-structures.md)
+- [ ] Pacing and Timing (pacing-timing.md)
+- [ ] Screen Continuity (screen-continuity.md)
+- [ ] Diversity and Inclusion (diversity-inclusion.md)
+
+---
+
+## Schema Validation
+
+### JSON Schema Files
+
+**character-profile.json:**
+- [ ] Valid JSON syntax
+- [ ] All required fields defined
+- [ ] Appropriate data types
+- [ ] Clear descriptions
+- [ ] Comprehensive coverage
+
+**beat-sheet.json:**
+- [ ] Save the Cat structure complete
+- [ ] All 15 beats included
+- [ ] Page number ranges appropriate
+- [ ] Clear descriptions
+
+**plot-outline.json:**
+- [ ] Three-act structure supported
+- [ ] Sequences and scenes defined
+- [ ] Turning points included
+- [ ] Flexible and comprehensive
+
+**trope-inventory.json:**
+- [ ] Trope categories comprehensive
+- [ ] Usage types defined
+- [ ] Cliché warnings included
+- [ ] Subversion strategies supported
+
+**screenplay-config.json:**
+- [ ] All configuration options included
+- [ ] Appropriate defaults
+- [ ] Clear descriptions
+- [ ] Tool integration options
+
+---
+
+## Example Files Review
+
+### Fountain Examples
+
+**aaa-hollywood-scene.fountain:**
+- [ ] Proper Fountain syntax
+- [ ] Demonstrates AAA Hollywood style
+- [ ] High-stakes action
+- [ ] Visual spectacle
+- [ ] Proper formatting
+
+**independent-monologue.fountain:**
+- [ ] Proper Fountain syntax
+- [ ] Character-driven
+- [ ] Emotional depth
+- [ ] Natural dialogue
+- [ ] Proper formatting
+
+**tv-episode-teaser.fountain:**
+- [ ] Proper Fountain syntax
+- [ ] Cliffhanger structure
+- [ ] Appropriate length
+- [ ] Engaging hook
+- [ ] Proper formatting
+
+**news-segment.fountain:**
+- [ ] Proper broadcast format
+- [ ] Timing marks included
+- [ ] B-roll notes
+- [ ] Production notes
+- [ ] Proper formatting
+
+**commercial-30sec.fountain:**
+- [ ] Proper commercial format
+- [ ] Timing breakdown
+- [ ] Call-to-action
+- [ ] Production notes
+- [ ] Proper formatting
+
+### YAML Examples
+
+**character-profile-example.yaml:**
+- [ ] Valid YAML syntax
+- [ ] Demonstrates schema usage
+- [ ] Comprehensive character data
+- [ ] Clear and detailed
+- [ ] Follows schema structure
+
+**beat-sheet-example.yaml:**
+- [ ] Valid YAML syntax
+- [ ] All 15 beats included
+- [ ] Demonstrates Save the Cat structure
+- [ ] Clear and detailed
+- [ ] Follows schema structure
+
+**plot-outline-example.yaml:**
+- [ ] Valid YAML syntax
+- [ ] Three-act structure
+- [ ] Sequences and scenes
+- [ ] Clear and detailed
+- [ ] Follows schema structure
+
+---
+
+## Integration Documentation Review
+
+### VS Code Integration (vscode-integration.md)
+
+- [ ] Better Fountain setup instructions
+- [ ] Configuration examples
+- [ ] Keyboard shortcuts
+- [ ] Export workflow
+- [ ] Troubleshooting section
+- [ ] Tips and best practices
+
+### Fountain Format (fountain-format.md)
+
+- [ ] Complete syntax reference
+- [ ] All elements covered
+- [ ] Clear examples
+- [ ] Best practices
+- [ ] Common mistakes
+- [ ] Conversion tools listed
+
+### AI Integration Testing (ai-integration-testing.md)
+
+- [ ] Testing checklist complete
+- [ ] Category-specific validation
+- [ ] Before/after examples
+- [ ] Common AI mistakes documented
+- [ ] Validation tools listed
+- [ ] Quality metrics defined
+
+### Formatting Validation (formatting-validation.md)
+
+- [ ] AMPAS standards documented
+- [ ] Element specifications complete
+- [ ] Validation checklist comprehensive
+- [ ] Common errors documented
+- [ ] Automated tools listed
+
+---
+
+## Consistency Review
+
+### Terminology
+
+- [ ] Consistent use of terms across all files
+- [ ] Industry-standard terminology
+- [ ] Clear definitions where needed
+
+### Formatting
+
+- [ ] Consistent markdown formatting
+- [ ] Consistent code block styling
+- [ ] Consistent heading hierarchy
+- [ ] Consistent list formatting
+
+### Examples
+
+- [ ] Examples are consistent with rules
+- [ ] Examples demonstrate best practices
+- [ ] Examples are realistic and practical
+
+---
+
+## Accuracy Review
+
+### Industry Standards
+
+- [ ] AMPAS standards accurately represented
+- [ ] BBC standards (if mentioned) accurate
+- [ ] Industry terminology correct
+- [ ] Page count guidelines accurate
+
+### Technical Accuracy
+
+- [ ] JSON schemas are valid
+- [ ] YAML examples are valid
+- [ ] Fountain syntax is correct
+- [ ] Code examples work as intended
+
+### Best Practices
+
+- [ ] Recommendations align with industry standards
+- [ ] Best practices are current and relevant
+- [ ] Advice is practical and actionable
+
+---
+
+## Completeness Review
+
+### Coverage
+
+- [ ] All screenplay categories covered
+- [ ] All major formatting elements documented
+- [ ] All common scenarios addressed
+- [ ] Sufficient examples provided
+
+### Gaps
+
+- [ ] No missing critical information
+- [ ] No broken references
+- [ ] No incomplete sections
+- [ ] No placeholder content
+
+---
+
+## Usability Review
+
+### Clarity
+
+- [ ] Instructions are clear and easy to follow
+- [ ] Examples are helpful and illustrative
+- [ ] Technical terms are explained
+- [ ] Organization is logical
+
+### Accessibility
+
+- [ ] Content is well-organized
+- [ ] Navigation is intuitive
+- [ ] Search-friendly structure
+- [ ] Appropriate level of detail
+
+---
+
+## Final Validation
+
+### Module Metadata
+
+- [ ] module.json version is correct
+- [ ] Character count is accurate
+- [ ] Description is accurate
+- [ ] All metadata fields complete
+
+### README
+
+- [ ] Comprehensive overview
+- [ ] Clear installation instructions
+- [ ] Directory structure documented
+- [ ] Contents listing complete
+- [ ] Character count included
+
+### Quality Standards
+
+- [ ] Professional quality throughout
+- [ ] No typos or grammatical errors
+- [ ] Consistent voice and tone
+- [ ] Ready for production use
+
+---
+
+## Issues Identified
+
+**Critical Issues:**
+- (List any critical issues found)
+
+**Minor Issues:**
+- (List any minor issues found)
+
+**Recommendations:**
+- (List any recommendations for improvement)
+
+---
+
+## Sign-Off
+
+**Reviewer:** _________________
+**Date:** _________________
+**Status:** [ ] Approved [ ] Needs Revision
+**Notes:** _________________
+