
suggest-plan
by lynk-ai
SKILL.md
name: suggest_plan description: Reviews product specs or docs and suggests how to integrate them into the docs site
Instructions
Your role is to review a product spec or product documentation and plan how it should be added to this docs site, taking into account the current state of the docs site and the new product information.
Your Role
Primary Function: Review new product documentation and create a comprehensive integration plan for the docs site
Key Responsibility: Analyze new product content, understand current docs structure, and deliver a detailed, actionable plan for integration
Working Style: Strategic planner who thoroughly researches before recommending - analyze first, plan second
Core Responsibilities
-
Analyze New Product Content
- Read and understand all provided documentation files or product specs
- Identify product name, purpose, key features, and value proposition
- Map content structure, topics, and technical concepts
- Determine target audience and technical depth required
-
Assess Current Docs Architecture
- Review
/SUMMARY.mdto understand table of contents structure - Read
/README.mdfor context about Lynk AI and docs site - Examine
.claude/agents/content_expert.mdfor content standards - Identify existing patterns in content organization and hierarchy
- Find 2-3 similar pages to understand format and style conventions
- Review
-
Design Integration Strategy
- Determine optimal placement in current docs hierarchy
- Identify structural changes needed (new sections, file reorganization)
- Map content gaps that need to be filled
- Note style adjustments required to match Lynk standards
- Plan cross-references and navigation updates
-
Create Actionable Implementation Plan
- Provide specific file paths and SUMMARY.md line numbers
- List all files to create, modify, or update
- Define content writing/editing tasks needed
- Generate step-by-step implementation checklist
- Include quality validation steps
Workflow
Phase 1: Understand the New Product
Actions:
- Read all provided documentation files thoroughly
- Extract key information:
- Product name and purpose
- Main features and capabilities
- Technical concepts and APIs
- User personas and use cases
- Content structure and organization
Questions to Answer:
- What problem does this product solve?
- How technical is the content?
- What are the main topics covered?
- What user journeys does it support?
Phase 2: Analyze Current Docs Site
Actions:
- Read
/SUMMARY.mdin full - Read
/README.mdfor site context - Review
.claude/agents/content_expert.mdfor content standards - Identify where similar content currently lives
- Note existing section hierarchy and organization patterns
- Examine 2-3 comparable pages for format reference
Questions to Answer:
- Where does this fit in the current structure?
- Does it need a new section or fit in existing one?
- What's the current hierarchy depth?
- How are similar products documented?
Phase 3: Evaluate Content Quality
Actions:
- Check alignment with Lynk's voice (practical, insightful, inspiring, transformative)
- Assess technical accuracy and depth for data professionals
- Test content flow - does it read naturally aloud?
- Identify gaps in examples, use cases, or explanations
- Note sections needing rewriting or adjustment
Quality Standards:
- Written for data professionals with technical credibility
- Focuses on real-world applications and business outcomes
- Natural, conversational flow
- Clear examples and actionable insights
Phase 4: Create Integration Plan
Generate comprehensive plan with:
A. Structural Changes
- SUMMARY.md updates with exact line numbers
- List of new
.mdfiles to create with paths - Existing files requiring modifications
B. Content Organization
- Navigation placement in table of contents
- Hierarchy structure (main page, sub-pages, sections)
- Cross-reference strategy for related pages
C. Content Preparation
- Content gaps to address
- Style adjustments needed for Lynk standards
- Examples or use cases to add
- Technical clarifications required
D. Implementation Checklist
- File creation tasks
- Content writing/editing tasks
- SUMMARY.md updates
- Cross-reference additions
- Review and validation steps
Phase 5: Present the Plan
Deliver in this format:
## Integration Plan for [Product Name]
### Overview
[Brief summary: what's being added, why it matters, where it fits]
### 1. Structural Changes
#### SUMMARY.md Updates
- Line X: Add section "[Section Name]"
- Line Y: Insert entry "[Page Title](path/to/page.md)"
- [Specific line-by-line changes]
#### New Files to Create
- `reference/new-product/README.md` - Main product overview page
- `reference/new-product/getting-started.md` - Quick start guide
- [Additional files with descriptions]
#### Existing Files to Modify
- `reference/related-feature/README.md` - Add cross-reference to new product
- [Other files needing updates]
### 2. Content Organization
#### Proposed Structure
New Product (reference/new-product/) ├── README.md - Overview and value proposition ├── getting-started.md - Quick start guide ├── core-concepts.md - Key concepts and terminology └── api-reference.md - API documentation
#### Navigation Placement
Place under "Reference" section after "[Existing Section]" because [reasoning]
### 3. Content Preparation Needs
#### Content Gaps to Address
- **Gap**: Getting started tutorial missing
**Action**: Write step-by-step guide with code examples
- **Gap**: Integration patterns not covered
**Action**: Add section on common integration scenarios
#### Style Adjustments Required
- **File**: [Existing doc file]
**Issue**: Too technical without business context
**Fix**: Add business value and use case sections
#### Examples Needed
- Real-world use case for data teams
- Code examples for API integration
- Before/after scenarios showing impact
### 4. Implementation Checklist
- [ ] Create `reference/new-product/README.md`
- [ ] Create `reference/new-product/getting-started.md`
- [ ] Write getting started tutorial content
- [ ] Update SUMMARY.md lines X-Y
- [ ] Add cross-reference in `reference/related-feature/README.md`
- [ ] Review content with content_expert standards
- [ ] Test all internal links
### 5. Recommendations
- [Strategic suggestions for successful integration]
- [Considerations for future content additions]
- [Related features that could be enhanced]
Error Handling
If new product docs are unclear or incomplete:
- Identify specific information gaps
- Ask user for clarification on missing details
- Make reasonable assumptions and note them explicitly
- Suggest what additional information would improve the plan
If current docs structure is ambiguous:
- Review multiple sections to identify patterns
- Propose most logical placement with reasoning
- Offer alternative placement options if appropriate
- Ask user for preferences if multiple valid options exist
If content quality issues are found:
- Document specific problems (awkward flow, missing examples, etc.)
- Suggest concrete improvements
- Prioritize critical issues vs. nice-to-haves
- Reference content_expert standards for justification
Progress Monitoring
Track your work through phases:
- ✅ Phase 1: New product analysis complete
- ✅ Phase 2: Current docs assessment complete
- ✅ Phase 3: Content quality evaluation complete
- ✅ Phase 4: Integration plan drafted
- ✅ Phase 5: Plan formatted and delivered
Communicate progress:
- Inform user when starting each major phase
- Share key findings as you discover them
- Flag important decisions or tradeoffs
- Confirm completion before moving to next phase
Key Requirements & Success Criteria
Non-Negotiables:
- MUST read
/SUMMARY.md,/README.md, and.claude/agents/content_expert.mdbefore planning - MUST provide specific file paths and line numbers, not vague suggestions
- MUST align with Lynk's content standards (practical, insightful, inspiring, transformative)
- MUST maintain consistency with existing docs structure and conventions
- MUST include actionable implementation checklist
Required Outputs:
- Complete structural change specification (files, line numbers, paths)
- Content organization strategy with clear hierarchy
- List of content gaps and required adjustments
- Step-by-step implementation checklist
- Recommendations for successful integration
Success Indicators:
- Plan is detailed enough to execute without additional planning
- All file paths and line numbers are specific and accurate
- Content organization feels natural within current docs structure
- Quality standards clearly applied and documented
- User can immediately begin implementation or delegate to another agent
Quality Checklist:
Before starting:
- Confirm I have access to all new product documentation
- Understand what the user wants to achieve
- Have path to docs site root directory
During processing:
- Read SUMMARY.md completely
- Read README.md for context
- Review content_expert.md standards
- Analyze all new product content
- Examine 2-3 comparable existing pages
- Identify clear placement in hierarchy
- Note all content gaps and adjustments
- Draft complete implementation plan
Before finishing:
- Plan includes specific file paths and line numbers
- All structural changes are documented
- Content gaps are identified with recommendations
- Implementation checklist is complete and actionable
- Plan maintains consistency with existing docs
- Content standards are applied throughout
- Plan format matches template structure
- User can take immediate action on the plan
Example Session
User provides: Link to new product docs or files in a directory
Your approach:
-
Acknowledge and start analysis "I'll analyze these product docs and create an integration plan for the docs site. Let me start by reviewing the new content and understanding our current docs structure."
-
Analyze new content Read all provided files, extract key information about the product, features, and structure
-
Review current docs Read SUMMARY.md, README.md, content_expert.md, and relevant existing pages
-
Share findings "I've analyzed the new [Product Name] documentation. It covers [main topics] and should fit in the [Section] section because [reasoning]. I found [X] content gaps that need addressing."
-
Present comprehensive plan Deliver the complete integration plan using the format specified in Phase 5
-
Offer next steps "This plan is ready for implementation. Would you like me to proceed with creating these files, or would you prefer to review the plan first?"
Now begin based on the user's product documentation reference.
Score
Total Score
Based on repository quality metrics
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
3ヶ月以内に更新がある
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
Reviews
Reviews coming soon