What are standard style conventions in markdown documents for short notes? For example,…
- User
What are standard style conventions in markdown documents for short notes? For example, documents one or two pages long meant to record a day's worth of observations.
- Assistant
When writing short notes in Markdown—such as daily observations or one- to two-page documents—it's helpful to follow some standard style conventions to ensure clarity, consistency, and ease of reading. Here are commonly used conventions for such documents:
1. Title and Metadata
- Use a top-level heading (
#) for the document title. - Optionally include metadata (e.g., date, author, tags) in a front matter block or as a list at the top.
# Daily Observations **Date:** 2024-04-15 **Author:** Jane Doe **Tags:** research, field-notes
2. Headings for Structure
- Use headings (
##,###, etc.) to break the document into logical sections. - Keep heading levels consistent and avoid skipping levels.
## Morning Observations ### Weather Conditions - Clear skies - Temperature: 18°C ### Wildlife Activity - Observed 3 deer near the stream
3. Bullet Points for Lists
- Use
-or*for unordered lists. - Use
1.,2., etc., for ordered steps or sequences. - Keep list items concise.
- Noticed increased bird activity - Soil moisture higher than yesterday
4. Timestamps or Time Blocks
- Use time markers to organize notes chronologically.
### 10:00 AM - Began setup of equipment - Noticed light wind from the west ### 12:30 PM - Lunch break - Reviewed morning data
5. Emphasis and Highlights
- Use
**bold**for important points or keywords. - Use
_italic_for emphasis or uncertainty.
- **Important:** Battery level dropped to 20% - _Possibly_ a new species of insect observed
6. Code or Data Snippets
- Use backticks for inline code or data values.
- Use triple backticks for blocks of code or tabular data.
Sensor reading: `23.7°C`Time Temp (°C) 10:00 18.2 12:00 21.5 14:00 23.7
7. Checklists (if applicable)
- Use
- [ ]for tasks or items to track completion.
### Equipment Checklist - [x] Camera - [x] GPS unit - [ ] Soil probe
8. Links and References
- Use
[text](url)for linking to related documents or resources.
See [April 14 Notes](2024-04-14-notes.md) for comparison.
9. Consistent Formatting
- Use consistent spacing, indentation, and punctuation.
- Avoid mixing styles (e.g., don't alternate between
*and-for lists).
10. Optional: Use Horizontal Rules
- Use
---to visually separate sections or time blocks.
--- ## Afternoon Observations
By following these conventions, your Markdown notes will be easier to read, search, and maintain—especially if you revisit them later or share them with others.
- Use a top-level heading (
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.