Skip to content
The Chat Archive
Geminigemini-2.0-flash-001· Google LMArena Human Preference 140K

What are standard style conventions in markdown documents for short notes? For example,…

  1. 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.

  2. Assistant

    Markdown doesn't have official style conventions like a style guide. However, there are widely adopted and common practices, especially for shorter, note-taking documents. Here's a breakdown of recommended style conventions, focused on optimizing for readability and quick understanding:

    1. Top-Level Metadata (Optional, but Recommended):

    • Title: Use a level 1 heading (#) as the title, ideally date-based. Examples:

      • # 2023-10-27 - Friday Observations
      • # Daily Notes - October 27, 2023
      • # Project X - Daily Log - 2023-10-27
    • Date: Even if in the title, including the date in a standard format at the top is good. YYYY-MM-DD is a universally understood format. You can include time, too, if granular timestamps are relevant.

      • Date: 2023-10-27
      • Created: 2023-10-27 09:00
      • Last Updated: 2023-10-27 17:30
    • Tags/Keywords: Use a dedicated line for tags to categorize notes for later searching. This is extremely helpful for organizing notes across days/projects. Use a consistent prefix (e.g., Tags:) and separate tags with commas or spaces.

      • Tags: ProjectX, Meeting, BugReport, PriorityHigh
      • Keywords: project-alpha, analysis, regression, critical
    • Author/Creator (If relevant):

      • Author: John Doe

    2. Structure and Headings:

    • Use Headings Strategically: Employ level 2 (##), level 3 (###), and level 4 (####) headings to divide the notes logically into sections. Common sections:

      • ## Meetings
      • ## Tasks Completed
      • ## Issues Encountered
      • ## Observations
      • ## Action Items
      • ## Questions
      • ## Next Steps
      • ## Decisions
    • Keep Headings Concise: Headings should be short and descriptive.

    • Consistent Heading Levels: Don't skip heading levels (e.g., don't go directly from ## to ####).

    3. Content Formatting:

    • Lists: Use ordered (1.) and unordered (-, *, or +) lists extensively to break down information into easily digestible points. Choose one character for unordered lists and stick with it.

    • Emphasis: Use *italics* or _italics_ for emphasis, and **bold** or __bold__ for stronger emphasis. Use sparingly; too much emphasis becomes noise.

    • Code:

      • Use backticks (`) for inline code snippets (e.g., function myFunc() {}).
      • Use triple backticks (```) for code blocks. Specify the language for syntax highlighting.
        function myFunc() {
          console.log("Hello!");
        }
        
    • Blockquotes: Use > for quoting text. Useful for pulling out key statements or summarizing conversations.

    • Horizontal Rules: Use ---, ***, or ___ to visually separate sections. Be consistent with your choice.

    • Links: Use standard markdown link syntax [Link Text](URL).

    • Images: Use ![Alt Text](URL) to embed images (if necessary, although images might be less common in short daily notes). Use descriptive alt text.

    4. Style Considerations:

    • Conciseness: Notes should be concise and to the point. Avoid unnecessary fluff.

    • Active Voice: Prefer active voice over passive voice.

    • Imperative Mood (for action items): Phrase action items in the imperative mood (e.g., "Review the code," not "The code should be reviewed").

    • Timestamping: Consider adding timestamps to specific notes, especially if chronology within a section is important. Example: [10:15 AM] - Met with John to discuss...

    • Highlighting: Use ==highlighting== (supported by some Markdown editors/renderers) to emphasize specific words or phrases that are crucial.

    • Abbreviations/Acronyms: If you use abbreviations or acronyms, define them the first time they appear.

    • Avoid Over-Formatting: Too much bolding, italics, or highlighting can be distracting. Use formatting to enhance readability, not to overwhelm the reader.

    Example:

    # 2023-10-27 - Project Alpha Daily Log
    
    Date: 2023-10-27
    Tags: ProjectAlpha, Meeting, CodeReview, BugFix
    
    ## Meetings
    
    *   [09:00 AM] Stand-up meeting with team.  Discussed progress on UI implementation.
    *   [11:00 AM] Meeting with client to review prototype.  Positive feedback overall.
    
    ## Tasks Completed
    
    *   Implemented user authentication feature.
    *   Fixed bug #123 (login error).
    *   Wrote unit tests for authentication module.
    
    ## Issues Encountered
    
    *   Performance bottleneck in database query.  Requires optimization. ==Investigate further.==
    
    ## Action Items
    
    *   Optimize database query. (Due: 2023-10-28)
    *   Send client updated prototype link.
    *   Schedule code review with Sarah.
    
    ## Questions
    
    *   What is the best approach for handling session management?
    *   Clarify the security requirements for data encryption.
    
    ## Next Steps
    
    *   Continue working on UI implementation.
    *   Address performance bottleneck issue.
    *   Begin planning for next sprint.
    

    Tools & Editors:

    Many Markdown editors provide features to streamline note-taking:

    • Typora: Excellent visual markdown editor with a focus on readability.
    • Obsidian: Powerful note-taking app with linking and graph features, suitable for larger knowledge bases.
    • VS Code: Great for developers; has excellent Markdown support with extensions.
    • Simplenote: Lightweight and simple, ideal for quick notes.
    • Bear: Beautiful and feature-rich Markdown note-taking app (macOS/iOS only).
    • Joplin: Open-source note-taking app with strong encryption capabilities.
    • Notion: Versatile workspace that supports Markdown and more.

    By consistently applying these conventions, you can create well-structured, easily readable, and highly useful markdown notes for daily observations and other short-form documentation. The key is to find a system that works best for you and stick with it!

Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.