AI Skill Report Card
Formatting Markdown
Quick Start
Markdown# Main Title Brief introduction paragraph.
Section Header
Content with bold and italic emphasis.
Subsection
- Bullet point
- Another point
code blocks
# Workflow
Progress:
- [ ] Structure with logical heading hierarchy (H1 → H2 → H3)
- [ ] Add frontmatter if needed (YAML/TOML)
- [ ] Format code blocks with language tags
- [ ] Create meaningful link text (no "click here")
- [ ] Add lists for scannable content
- [ ] Include tables for structured data
- [ ] Review for mobile readability
**Document Types:**
1. **README**: Project overview, installation, usage
2. **Documentation**: API docs, guides, tutorials
3. **Notes**: Meeting notes, research, brainstorming
4. **Articles**: Blog posts, technical writing
# Examples
**Example 1 - Code Documentation:**
Input: Function that processes user data
Output:
```markdown
processUserData()
Validates and sanitizes user input before database storage.
Parameters
userData(Object): Raw user inputoptions(Object): Validation rules
Returns
Promise<Object> - Cleaned user data
Example
JavaScriptconst clean = await processUserData(input, { strict: true });
Example 2 - Project README: Input: Python automation script Output:
Markdown# Email Automation Tool Sends personalized emails based on CSV data.
Quick Start15 / 15
Bashpip install -r requirements.txt python email_tool.py --file contacts.csv
Recommendation▾
Add concrete input/output examples showing before/after transformations of actual content
Features
- CSV import
- Template variables
- Rate limiting
# Best Practices
- **One H1 per document** - Use for main title only
- **Logical hierarchy** - Don't skip heading levels (H2 → H4)
- **Code language tags** - Always specify language for syntax highlighting
- **Meaningful links** - Use descriptive anchor text
- **Lists for scanning** - Break up dense paragraphs
- **Tables for data** - Use pipe syntax for structured information
- **Line breaks** - Two spaces at end for hard breaks
- **Escape characters** - Use backslash for literal asterisks, underscores
# Common Pitfalls
- Don't use multiple H1s in one document
- Don't write "Click here" or generic link text
- Don't forget language tags on code blocks
- Don't mix list styles within same level
- Don't use HTML when Markdown syntax exists
- Don't create walls of text - break into sections
- Don't forget to escape special characters in regular text