report-writing

Solid

Guidelines for writing well-structured, cited research reports

AI & Automation 859 stars 98 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
98
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
91
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Report Writing Guide ## Report Structure ### 1. Title - Descriptive and specific - Include the scope or time frame if relevant - Example: "Advances in Protein Folding Since AlphaFold 3 (2024-2025)" ### 2. Executive Summary - 2-3 paragraphs summarizing key findings - Written last, after the full report is complete - Should stand alone — a reader should understand the main conclusions ### 3. Body Sections - Organize logically (chronological, thematic, or comparative) - Each section should address one sub-topic - Use inline citations [1][2] for every factual claim - Include data, statistics, and direct quotes where appropriate ### 4. Conclusions - Synthesize findings across all sections - Highlight key takeaways and implications - Note limitations of the research - Suggest areas for further investigation ### 5. References - Number references in order of first appearance - Format: `[N] Author/Organization, "Title", URL, Accessed: YYYY-MM-DD` ## Writing Style ### Clarity - Use clear, direct language - Define technical terms on first use - Prefer active voice over passive - Keep paragraphs focused on one idea ### Objectivity - Present evidence before conclusions - Acknowledge counter-arguments - Use hedging language for uncertain claims ("suggests", "indicates", "appears to") - Distinguish between facts and interpretation ### Citation Practices - Cite every factual claim, statistic, and quote - Use inline citations [N] immediately after the claim - Multiple citations fo...

Details

Author
vstorm-co
Repository
vstorm-co/pydantic-deepagents
Created
6 months ago
Last Updated
yesterday
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category