@riotprompt/riotdoc 1.0.1-dev.0 → 1.0.4

package/templates/research-paper-template.md

@@ -0,0 +1,497 @@
+# Research Paper Document Template
+
+## Template Structure
+
+This defines the structure and questions for creating research paper documents in RiotDoc.
+
+**Template Type**: research-paper  
+**Version**: 2.0  
+**Last Updated**: 2026-01-30
+
+---
+
+## Questions to Answer
+
+### Idea/Draft Phase
+
+These are the questions you can answer **NOW** when starting your research paper. Focus on the core research question and approach.
+
+#### Core Research
+- **Research question**: What are you investigating?
+- **Hypothesis**: What do you expect to find? (if applicable)
+- **Field/discipline**: What area of study?
+- **Significance**: Why does this research matter?
+
+#### Background & Context
+- **Literature review**: What existing research is relevant?
+- **Research gap**: What's missing in current knowledge?
+- **Theoretical framework**: What theories or models are you using?
+
+#### Methodology
+- **Research design**: Qualitative, quantitative, mixed methods?
+- **Data collection**: How will you gather data?
+- **Analysis approach**: How will you analyze the data?
+- **Limitations**: What are the constraints or boundaries?
+
+#### Scope
+- **Target audience**: Academic peers, practitioners, general public?
+- **Length**: Short paper (3-5k words), standard (6-8k), extended (10k+)?
+
+---
+
+### Publishing Phase
+
+These are questions you figure out **LATER** - when preparing for submission and publication.
+
+#### Publication Details
+- **Target journal/venue**: Where will this be published?
+- **Citation style**: APA, MLA, Chicago, IEEE, etc.?
+- **Formatting requirements**: Does venue have specific formatting rules?
+- **Sections required**: Does venue require specific sections or structure?
+- **Word/page limits**: Specific length constraints?
+
+#### Citations & References
+- **Reference management**: How are you managing citations? (Zotero, EndNote, Mendeley)
+- **Citation completeness**: All sources properly cited?
+- **Reference list**: Formatted correctly per style guide?
+
+#### Supplementary Materials
+- **Figures and tables**: All properly labeled and referenced?
+- **Appendices**: What supplementary material to include?
+- **Data availability**: Will you share data? Where?
+- **Code/materials**: Any code or materials to share?
+
+#### Submission
+- **Co-authors**: Who are the co-authors? Order?
+- **Acknowledgments**: Who to thank? Funding sources?
+- **Conflicts of interest**: Any conflicts to disclose?
+- **Ethics approval**: IRB or ethics board approval needed?
+- **Keywords**: What keywords for indexing?
+
+---
+
+## Available Approaches
+
+Choose the approach that best fits your research scope and publication goals.
+
+### Approach 1: Short Paper
+
+**When to use**:
+- Conference paper or workshop submission
+- Preliminary findings or work-in-progress
+- Limited scope or focused question
+- Short page limit (4-8 pages)
+- Quick turnaround needed
+
+**Strategy**:
+- Focus on one key finding or contribution
+- Concise literature review (1-2 pages)
+- Streamlined methodology section
+- Clear but brief results and discussion
+- Minimal appendices
+
+**Output**: Short research paper, 3,000-5,000 words
+
+**Workflow**:
+1. Answer core Idea/Draft questions
+2. Conduct focused literature review
+3. Design and execute research
+4. Analyze data
+5. Create outline with required sections
+6. Draft each section concisely
+7. Create figures/tables (limit to 2-4)
+8. Write abstract (150 words)
+9. Answer Publishing phase questions
+10. Format per venue requirements
+11. Get co-author feedback
+12. Revise and polish
+13. Submit
+
+**Timeline**: 1-3 months from research to submission
+
+---
+
+### Approach 2: Standard Paper
+
+**When to use**:
+- Journal article submission
+- Complete research study
+- Standard academic contribution
+- Typical page limit (8-15 pages)
+- Thorough treatment of topic
+
+**Strategy**:
+- Comprehensive literature review
+- Detailed methodology section
+- Full presentation of results
+- In-depth discussion and implications
+- Proper appendices for supplementary material
+
+**Output**: Standard research paper, 6,000-8,000 words
+
+**Workflow**:
+1. Answer all Idea/Draft phase questions
+2. Conduct comprehensive literature review
+3. Design research methodology
+4. Collect and analyze data
+5. Create detailed outline
+6. Draft introduction and literature review
+7. Draft methodology section
+8. Draft results section with figures/tables
+9. Draft discussion section
+10. Draft conclusion
+11. Write abstract (200-250 words)
+12. Answer all Publishing phase questions
+13. Format references and citations
+14. Create all figures and tables
+15. Write appendices if needed
+16. Get co-author feedback
+17. Revise thoroughly (2-3 rounds)
+18. Proofread carefully
+19. Submit
+
+**Timeline**: 3-6 months from research to submission
+
+---
+
+### Approach 3: Extended Paper with Appendices
+
+**When to use**:
+- Dissertation chapter or thesis
+- Extensive research study
+- Multiple research questions or studies
+- Long form publication (15+ pages)
+- Requires substantial supplementary material
+
+**Strategy**:
+- Extensive literature review (multiple sections)
+- Detailed methodology with justification
+- Multiple studies or experiments
+- Comprehensive results with multiple analyses
+- Thorough discussion of implications
+- Substantial appendices with additional data
+
+**Output**: Extended research paper, 10,000+ words with appendices
+
+**Workflow**:
+1. Answer all Idea/Draft phase questions
+2. Conduct extensive literature review (may be ongoing)
+3. Design comprehensive research methodology
+4. Collect data (may be multiple studies)
+5. Analyze data with multiple approaches
+6. Create detailed outline with all sections
+7. Draft introduction (2-3 pages)
+8. Draft literature review (5-10 pages)
+9. Draft methodology (3-5 pages)
+10. Draft results for each study/analysis
+11. Draft discussion (4-6 pages)
+12. Draft conclusion (2-3 pages)
+13. Write comprehensive abstract (250 words)
+14. Answer all Publishing phase questions
+15. Create all figures, tables, and visualizations
+16. Write appendices (data, instruments, additional analyses)
+17. Format all references and citations
+18. Get co-author feedback
+19. Revise extensively (3-5 rounds)
+20. Professional editing if needed
+21. Final proofread
+22. Submit
+
+**Timeline**: 6-12 months from research to submission
+
+---
+
+## Output Document Structure
+
+```markdown
+# [Paper Title]
+
+**Author(s)**: [Names and affiliations]
+**Date**: [Date]
+**Keywords**: [keyword1, keyword2, keyword3, keyword4, keyword5]
+
+---
+
+## Abstract
+
+[150-250 word summary covering:
+- Research question/objective
+- Methodology
+- Key findings
+- Main conclusions
+- Implications]
+
+---
+
+## 1. Introduction
+
+### 1.1 Background
+[Context and background information that sets up the research question]
+
+### 1.2 Research Question
+[Clear statement of what you're investigating]
+[Specific research questions or hypotheses]
+
+### 1.3 Significance
+[Why this research matters]
+[Theoretical and practical contributions]
+
+### 1.4 Paper Structure
+[Brief overview of how the paper is organized]
+
+---
+
+## 2. Literature Review
+
+### 2.1 [Topic Area 1]
+[Review of relevant literature on first major theme]
+[Key theories, findings, debates]
+
+### 2.2 [Topic Area 2]
+[Review of relevant literature on second major theme]
+
+### 2.3 [Topic Area 3]
+[Additional topic areas as needed]
+
+### 2.4 Research Gap
+[What's missing in current knowledge]
+[How this paper addresses the gap]
+
+---
+
+## 3. Theoretical Framework (if applicable)
+
+### 3.1 [Theory/Model Name]
+[Description of theoretical framework]
+[How it applies to this research]
+
+---
+
+## 4. Methodology
+
+### 4.1 Research Design
+[Overall approach: qualitative, quantitative, mixed methods]
+[Justification for chosen approach]
+
+### 4.2 Data Collection
+[Participants/sample]
+[Instruments or tools used]
+[Procedures followed]
+
+### 4.3 Data Analysis
+[Analysis methods used]
+[Software or tools]
+[Steps in analysis process]
+
+### 4.4 Validity and Reliability
+[How validity/reliability was ensured]
+
+### 4.5 Ethical Considerations
+[IRB approval, informed consent, etc.]
+
+### 4.6 Limitations
+[Acknowledged constraints and boundaries]
+
+---
+
+## 5. Results
+
+### 5.1 [Finding 1]
+[Presentation of first major finding]
+[Tables, figures, or data visualization]
+
+### 5.2 [Finding 2]
+[Presentation of second major finding]
+
+### 5.3 [Additional Findings]
+[Other significant results]
+
+---
+
+## 6. Discussion
+
+### 6.1 Interpretation of Findings
+[What the results mean]
+[How they answer the research question]
+
+### 6.2 Theoretical Implications
+[How findings contribute to theory]
+
+### 6.3 Practical Implications
+[Real-world applications or recommendations]
+
+### 6.4 Comparison with Prior Research
+[How findings relate to existing literature]
+[Confirmations, contradictions, extensions]
+
+### 6.5 Limitations and Constraints
+[Discussion of study limitations]
+[How they affect interpretation]
+
+---
+
+## 7. Conclusion
+
+### 7.1 Summary
+[Brief recap of research question, methods, and findings]
+
+### 7.2 Contributions
+[What this adds to the field]
+[Key takeaways]
+
+### 7.3 Future Research
+[Questions for further investigation]
+[Directions for future work]
+
+---
+
+## References
+
+[All citations in specified format - APA, MLA, Chicago, IEEE, etc.]
+
+[Author, A. A. (Year). Title of work. Publisher.]
+[Author, B. B., & Author, C. C. (Year). Title of article. Journal Name, Volume(Issue), pages.]
+
+---
+
+## Appendices
+
+### Appendix A: [Title]
+[Supplementary material - survey instruments, interview protocols, additional data, etc.]
+
+### Appendix B: [Title]
+[Additional supplementary material]
+```
+
+---
+
+## Example Use Cases
+
+### Academic Research
+- Journal articles
+- Conference papers
+- Dissertation chapters
+- Thesis papers
+
+### Applied Research
+- White papers
+- Technical reports
+- Policy briefs
+- Industry research
+
+### Review Papers
+- Literature reviews
+- Systematic reviews
+- Meta-analyses
+
+---
+
+## Research Paper Writing Tips
+
+### For Short Papers
+- Focus on one clear contribution
+- Be selective with literature review
+- Keep methodology concise but complete
+- Prioritize most important findings
+- Every word counts - be concise
+
+### For Standard Papers
+- Balance breadth and depth
+- Thorough but focused literature review
+- Detailed methodology for replication
+- Present results clearly with visuals
+- Discuss implications thoroughly
+
+### For Extended Papers
+- Organize with clear structure
+- Comprehensive literature review
+- Multiple studies or analyses
+- Extensive discussion of implications
+- Use appendices for supplementary material
+
+---
+
+## Common Pitfalls to Avoid
+
+❌ **Don't**: Start writing before defining research question
+✅ **Do**: Clarify research question before anything else
+
+❌ **Don't**: Ignore existing literature
+✅ **Do**: Conduct thorough literature review first
+
+❌ **Don't**: Use methodology that doesn't match question
+✅ **Do**: Choose methods appropriate for your question
+
+❌ **Don't**: Present results without interpretation
+✅ **Do**: Discuss what results mean and why they matter
+
+❌ **Don't**: Overclaim or overstate findings
+✅ **Do**: Be honest about limitations and scope
+
+❌ **Don't**: Wait until last minute to format references
+✅ **Do**: Use reference manager from the start
+
+---
+
+## Academic Writing Guidelines
+
+### Structure
+- Follow IMRAD structure (Introduction, Methods, Results, And Discussion)
+- Use clear section headings
+- Maintain logical flow between sections
+- Use transitions between paragraphs
+
+### Style
+- Write in third person (usually)
+- Use past tense for what you did
+- Use present tense for general truths
+- Be precise and specific
+- Avoid jargon when possible
+
+### Citations
+- Cite all sources appropriately
+- Use consistent citation style
+- Don't over-cite or under-cite
+- Include page numbers for direct quotes
+- Use reference management software
+
+### Figures and Tables
+- Number all figures and tables
+- Include descriptive captions
+- Reference in text before they appear
+- Keep visuals clear and readable
+- Follow venue formatting guidelines
+
+---
+
+## Template Notes
+
+**Version 2.0 Changes** (2026-01-30):
+- Split questions into Idea/Draft and Publishing phases
+- Added three approaches: Short Paper, Standard Paper, Extended Paper
+- Enhanced methodology and discussion sections
+- Added academic writing guidelines
+- Follows canonical template structure from TEMPLATE-STRUCTURE.md
+
+**When to use this template**:
+- Academic research papers
+- Conference submissions
+- Journal articles
+- Thesis/dissertation chapters
+- Technical reports
+- White papers
+
+---
+
+## Related Templates
+
+- **Blog Post Template**: For research blog posts or summaries
+- **Project Plan Template**: For research project planning
+- **Meeting Notes Template**: For research team meetings
+
+---
+
+## Version History
+
+- **v2.0** (2026-01-30): Added lifecycle phases and approaches
+- **v1.0** (2026-01-XX): Initial template (no phase split)

package/dist/__vite-browser-external-l0sNRNKZ.js

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=__vite-browser-external-l0sNRNKZ.js.map

package/dist/__vite-browser-external-l0sNRNKZ.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"__vite-browser-external-l0sNRNKZ.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}