UNPKG

myaidev-method

Version:

Comprehensive development framework with SPARC methodology for AI-assisted software development, AI visual content generation (Gemini, Imagen, DALL-E, Veo, FLUX), multi-platform publishing (WordPress, PayloadCMS, Astro, Docusaurus, Mintlify), and Coolify

240 lines (191 loc) 6.89 kB
# Content Generation Rules This file contains custom rules and guidelines for the content-writer agent. Copy this file to `content-rules.md` in your project root and customize it for your specific content needs. ## Brand Voice & Tone - **Primary Tone**: Professional yet approachable - **Reading Level**: 8th-10th grade (accessible to broad audience) - **Perspective**: Use "we" and "you" for engagement - **Personality Traits**: Helpful, knowledgeable, encouraging ## Writing Style Guidelines ### Sentence Structure - Keep sentences under 25 words when possible - Vary sentence length for rhythm - Use active voice (passive voice < 10% of content) - One main idea per sentence ### Paragraph Guidelines - Maximum 3-4 sentences per paragraph - Start paragraphs with topic sentences - Include white space for readability - Break up long sections with subheadings ### Word Choice - Prefer simple words over complex alternatives - Avoid jargon unless necessary (then explain it) - Use specific, concrete language - Minimize adverbs and weak verbs ## Formatting Preferences ### Headings - H1: Article title only - H2: Main section headers (4-7 words) - H3: Subsection headers (3-5 words) - H4: Rarely used, only for deeply nested content ### Lists - Use numbered lists for sequential steps or ranked items - Use bullet points for non-sequential items - Keep list items parallel in structure - Include 3-7 items per list (optimal for comprehension) ### Emphasis - **Bold** for key terms and important concepts - *Italics* for emphasis and technical terms - `Code formatting` for code, commands, file names - > Blockquotes for important callouts or quotes ## SEO Requirements ### Keywords - Primary keyword density: 1-2% - Include primary keyword in: title, first paragraph, at least one H2, conclusion - Natural keyword variations throughout - LSI keywords to support topic relevance ### Meta Elements - Meta description: 150-160 characters - Title tag: 50-60 characters - URL slug: lowercase, hyphens, primary keyword - Alt text: descriptive, includes keyword when natural ### Internal Linking - Link to 2-3 related internal articles - Use descriptive anchor text - Link from relevant context, not forced ### Featured Snippets - Include FAQ section for informational content - Use numbered lists for "how-to" content - Create summary paragraphs for definitions - Structure tables for comparison content ## Content Structure ### Introduction - Hook reader within first 1-2 sentences - State article value proposition - Preview main points or sections - Length: 100-150 words ### Body Content - Use the inverted pyramid style (most important first) - Include examples, data, or case studies - Break up text with subheadings every 300-400 words - Add images/visuals every 500-700 words ### Conclusion - Summarize key takeaways (3-5 points) - Include clear call-to-action - Suggest next steps or related content - Length: 100-200 words ## Required Elements ### Must Include - [ ] Author attribution - [ ] Publication date - [ ] Reading time estimate - [ ] Category/tags for organization - [ ] Social sharing metadata - [ ] Call-to-action (CTA) ### Optional Elements - Table of contents (for 1500+ word articles) - FAQ section (for informational content) - Key takeaways box - Related resources section - Expert quotes or testimonials ## Content Types Specific Guidelines ### Blog Posts - Length: 800-1500 words - Conversational tone - Include personal anecdotes or examples - Strong opening hook - Social sharing friendly ### Technical Articles - Length: 1200-2500 words - More formal, precise language - Code examples with explanations - Step-by-step instructions - Prerequisites section ### Product Reviews - Length: 1000-1800 words - Balanced pros and cons - Real-world testing experience - Comparison tables - Clear recommendation ### How-To Guides - Length: 800-2000 words - Numbered step-by-step instructions - Screenshots or diagrams - Prerequisites and materials list - Troubleshooting section ## Topics & Restrictions ### Topics to Avoid - Political opinions or endorsements - Medical diagnoses or treatment advice - Financial investment recommendations - Legal advice - Controversial or divisive subjects ### Topics to Handle Carefully - Competitor mentions (factual only, no negativity) - Statistics and data (always cite sources) - Future predictions (use qualifiers like "may" or "could") - Industry trends (acknowledge uncertainty) ## Quality Standards ### Fact-Checking - Verify all statistics and data - Link to original sources - Use reputable sources only (.gov, .edu, industry leaders) - Update outdated information - Date-stamp time-sensitive content ### Originality - 100% original content (no plagiarism) - Unique perspective or insights - Fresh examples, not recycled from competitors - Add value beyond what already exists ### Accessibility - Use descriptive link text (no "click here") - Provide alt text for all images - Ensure sufficient color contrast - Structure content for screen readers - Use simple language for complex topics ## Brand-Specific Requirements ### Company Information - Company Name: [Your Company] - Website: [Your Website] - Industry: [Your Industry] - Target Audience: [Your Audience] ### Preferred Terminology - Use "client" instead of "customer" - Use "platform" instead of "software" - Use "solution" instead of "product" - [Add your specific terms] ### Branding Elements - Include company tagline when relevant - Link to company blog or resources - Mention company values or mission when appropriate - Use consistent product/service names ### Call-to-Action Guidelines - Primary CTA: [e.g., "Start Free Trial"] - Secondary CTA: [e.g., "Contact Sales"] - Placement: End of article, after value is demonstrated - Style: Action-oriented, clear benefit ## Compliance & Legal ### Disclaimers - Include disclaimers for advice content - Note affiliate relationships if applicable - Privacy policy compliance - Cookie consent requirements ### Copyright - Respect copyright for quotes (cite source) - Obtain permission for extensive quotes - Use Creative Commons images only - Credit photographers/creators ## Review Checklist Before submitting content, verify: - [ ] Custom rules applied consistently - [ ] All required elements included - [ ] SEO optimized (title, meta, keywords) - [ ] Factual accuracy verified - [ ] No spelling or grammar errors - [ ] Links working and relevant - [ ] Images optimized and have alt text - [ ] Mobile-friendly formatting - [ ] Readability score meets target - [ ] Brand voice consistent - [ ] CTA clear and actionable --- **Note**: These are template rules. Customize this file for your specific content needs, brand voice, and target audience. The content-writer agent will use these rules to guide content generation while maintaining its core quality standards.