mcpField
O
obsidian-notes-creator

obsidian-notes-creator

github.com/szeyuProductivity30624 installsUpdated 2d ago
Repository

About obsidian-notes-creator

A note-writing skill for Obsidian users that structures explanations, examples, and visuals around the intended reader. It can also audit notes and report concrete gaps, with emphasis on accuracy, readability, and honest verification.

Key features

  1. 01Create, improve, or audit notes
  2. 02Adapt explanations to reader knowledge
  3. 03Develop reasoning and worked examples
  4. 04Choose suitable visual formats
  5. 05Check links, calculations, and figures
  6. 06Report coverage and unresolved issues

Use cases

  1. 01Write study notes for a new topic
  2. 02Deepen notes while preserving their structure
  3. 03Find gaps across a folder of notes
  4. 04Verify calculations and diagrams in notes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/szeyu/vibe-study-skills --skill obsidian-notes-creator

After installing, type/obsidian-notes-creatorin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
quality-checklist.md
verification.md
references/components/
callouts.md
diagrams.md
frontmatter.md
wikilinks.md
references/structure/
index-note.md
multi-file.md
single-note.md
references/writing/
analogies.md
comparisons.md
examples.md
intuition-first.md
teaching-style.md

Details

From the project README

Obsidian Notes Creator

Make notes accurate, easy for the intended reader to understand, and useful for solving unfamiliar problems. Match depth to the learner and the requested scope; decoration and length are not evidence of quality. Correct but hard-to-read notes are not finished.

1. Inspect and choose the mode

  • Create: identify the source, audience, prerequisites, and learning objectives before choosing a structure.
  • Improve: read existing notes, neighbouring notes, assets, and relevant vault instructions. Repair and deepen those files in place. Preserve filenames, folders, links, original dates, and useful author wording. Do not create a parallel study guide, rename files, or impose a new folder tree unless requested or necessary to the task.
  • Audit: report specific gaps with file references; do not silently rewrite an audit-only request.

Know the reader. Before writing, state in one or two sentences who the reader is and what they already know (for example, "comfortable with Python and high-school algebra, new to this notation"). Build explanations on that knowledge. Ask the user when it is unclear and it would change the writing.

For a folder-wide task, inventory every Markdown file first. Track each as unreviewed, reviewed unchanged, improved, or unresolved, with a short reason. A small selection of polished notes is a targeted pass, not a completed folder review. Keep this working record outside the notes unless requested.

Defaults: answers and solutions are directly visible; SVG figures have a white background. Explicit user preferences override these defaults.

2. Understand before expanding

Identify missing reasoning, prerequisites, assumptions, definitions, and misleading claims. Distinguish source statements from derived examples and uncertain material. Keep source citations near the claims they support; never invent page numbers, measurements, or experimental results.

Prioritise correctness, complete worked reasoning, and useful connections. Add a visual, analogy, table, or exercise only when it teaches something the existing explanation does not.

3. Explain and demonstrate

For unfamiliar material, connect motivation and intuition to the formal statement. Reference notes may lead with a definition; worked problems may lead with the question. No mandatory analogy or diagram quota.

Write plainly: one idea per sentence, terms defined on first use, an example right after each claim, concrete cases before the general rule, and fine-print caveats moved to a later section rather than interrupting the main explanation.

  • Teaching style: reader-first writing, notation decoding, bridges from familiar ideas, common mistakes, consistent note shape, layering, practice types, clean page layout, and a final beginner read-through.

  • Intuition and mathematics: symbols, assumptions, derivations, and limits.

  • Analogies: explicit mapping and where it breaks.

  • Examples: complete solutions, independent checks, and diagnostic questions.

  • Comparisons: method choice, guarantees, and fair evidence.

4. Use the appropriate representation

Choose prose, a table, ASCII, Mermaid, or SVG according to what the reader needs to see. Keep equations in rendered LaTeX. Make visuals consistent with the surrounding worked example.

5. Verify and report honestly

Use the verification workflow and quality checklist. Verify calculations separately from rendering. Inspect generated figures at their intended embed size. Check changed links and assets.

Report coverage, substantive improvements, checks actually run, and unresolved issues. Distinguish reviewed, executed, and rendered. Never claim exhaustive validation from samples, syntax checks, or file counts alone.

Comments

Markdown supported