# Vocabulary Notes

> Requirements for formatting and structuring the notes field in je-dict-1 entries. Covers formatting, content organization, and readability standards.

- Skill: `majiayu000/vocabulary-notes` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add majiayu000/vocabulary-notes`
- Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/vocabulary-notes/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: majiayu000 (https://skillmd.com/u/majiayu000)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/majiayu000/vocabulary-notes

---


# Vocabulary Notes Guidelines

The `notes` field is a critical part of each entry, providing usage information, grammar patterns, cultural context, and other details that help learners deeply understand the word. As the dictionary grows, well-structured notes become increasingly important.

## Formatting Requirements (HIGH PRIORITY)

### 1. Line Breaks Between Sections

Notes with multiple topics MUST separate each topic with a blank line:

```
✓ CORRECT:
{知|し}る means to learn or come to know something for the first time.

{知|し}っている (the ている form) means 'to know' - the state of already having that knowledge.

Common mistake: Using {知|し}る when you mean 'I know.'

✗ INCORRECT:
{知|し}る means to learn or come to know something for the first time. {知|し}っている (the ている form) means 'to know' - the state of already having that knowledge. Common mistake: Using {知|し}る when you mean 'I know.'
```

### 2. Bullet Points for Lists

Any list of 2 or more items MUST use bullet points. Use the hyphen-space format (`- `):

```
✓ CORRECT:
Common compounds:
- {案内|あんない}{所|じょ}: information desk
- {道|みち}{案内|あんない}: directions
- ご{案内|あんない}: guidance (polite)

✗ INCORRECT:
Common compounds: {案内|あんない}{所|じょ} (information desk), {道|みち}{案内|あんない} (directions), ご{案内|あんない} (guidance, polite)
```

### 3. Section Headers

Use clear section headers followed by a colon for distinct categories of information:

```
TRANSITIVITY:
- Type: {自動詞|じどうし} (intransitive)
- Pair: {上|あ}げる (transitive)

COMMON PATTERNS:
- {値段|ねだん}が{上|あ}がる (prices rise)
- {気温|きおん}が{上|あ}がる (temperature rises)
```

### 4. Single-Topic Notes

For entries with only one note or a simple explanation, a single paragraph is acceptable:

```
✓ ACCEPTABLE:
この is a demonstrative that refers to things near the speaker. It always modifies a noun and cannot stand alone.
```

## Content Categories

Notes should include relevant information from these categories, in approximate order of priority:

### For All Entries

1. **Core semantic explanation** - What the word fundamentally means beyond the gloss
2. **Similar word distinctions** - How this word differs from near-synonyms
3. **Common collocations** - Typical word pairings that aid natural usage
4. **Register notes** - Formality level and situational appropriateness
5. **Common mistakes** - What learners typically get wrong
6. **Cultural context** - When cultural background aids understanding

### Entry-Type-Specific Content

See the corresponding skill for type-specific requirements:
- **Verbs**: See `verb-entry` skill (transitivity, aspect, particle patterns)
- **Adjectives**: See `adjective-entry` skill (forms, similar words)
- **Particles**: See `particle-entry` skill (predicate lists, contrasts)
- **Nouns/Adverbs/Expressions**: See `other-entries` skill

## Structure Templates

### Verb Notes Template

```
[One-sentence summary of the verb's core meaning.]

TRANSITIVITY:
- Type: {自動詞|じどうし}/{他動詞|たどうし}
- Pair: [pair verb] (if exists)

ASPECT (ている):
[Explanation of what ている means for this verb]

COMMON PATTERNS:
- [pattern 1]
- [pattern 2]
- [pattern 3]

[Additional notes: register, negative usage, keigo, etc.]
```

### Noun Notes Template

```
[One-sentence explanation of the noun's scope or meaning.]

COMMON EXPRESSIONS:
- [collocation 1]
- [collocation 2]

[Scope clarification if different from English]

[Related words if helpful]
```

### Adjective Notes Template

```
[Adjective] is an [i-adjective/na-adjective].

FORMS:
- Adverbial: [form]
- Noun form: [form] (if natural)

SIMILAR WORDS:
- [word 1] vs. [word 2]: [distinction]

[Register or special usage notes]
```

### Simple Entry Template

For entries that don't need extensive notes:

```
[Core explanation in 1-2 sentences.]

[One optional list of 2-3 related items if helpful.]
```

## Formatting Technical Details

### Newlines in JSON

In the JSON `notes` field, use `\n` for line breaks and `\n\n` for paragraph breaks:

```json
"notes": "First paragraph here.\n\nSecond paragraph here.\n\nBullet list:\n- Item one\n- Item two"
```

### Furigana (CRITICAL)

**All kanji in notes MUST have furigana** using the `{漢字|かな}` notation.

This is a common source of errors. Every kanji - in idioms, collocations, cultural notes, alternative kanji forms, etc. - must be annotated:

```
✓ {案内|あんない}する means to guide.
✗ 案内する means to guide.

✓ IDIOM: {暖簾|のれん}に{腕押|うでお}し
✗ IDIOM: 暖簾に腕押し

✓ KANJI: Sometimes written as {家鴨|あひる}
✗ KANJI: Sometimes written as 家鴨
```

**Verify with:**
```bash
python3 build/verify_furigana.py <entry_id>
```

### Punctuation

- Use Japanese punctuation (。、) within Japanese text
- Use English punctuation in English explanations
- Colons after section headers: `COMMON PATTERNS:`
- Hyphens for bullet points: `- item`

## Quality Checklist

Before finalizing notes:

- [ ] Multiple topics are separated by blank lines
- [ ] Lists of 2+ items use bullet points
- [ ] **All kanji have furigana** - including idioms, collocations, kanji variants
- [ ] Verify: `python3 build/verify_furigana.py <entry_id>` shows "✓ OK"
- [ ] Section headers are clear and consistent
- [ ] Information is ordered by usefulness to learners
- [ ] No run-on paragraphs mixing unrelated information
- [ ] Length is appropriate (not too sparse, not overwhelming)

## Examples of Well-Formatted Notes

### Example 1: Verb Entry

```
{開|あ}く is an intransitive verb meaning something opens by itself or becomes open.

TRANSITIVITY:
- Type: {自動詞|じどうし} (intransitive)
- Pair: {開|あ}ける (transitive, to open something)

ASPECT (ている):
- {開|あ}いている means 'is open' (resulting state), not 'is opening'
- Example: {店|みせ}が{開|あ}いている = The store is open

COMMON PATTERNS:
- {ドア|どあ}が{開|あ}く (door opens)
- {店|みせ}が{開|あ}く (store opens)
- {花|はな}が{開|あ}く (flower blooms)
- {穴|あな}が{開|あ}く (hole opens/forms)
```

### Example 2: Noun Entry

```
{電話|でんわ} refers to both the telephone device and the act of calling.

COMMON EXPRESSIONS:
- {電話|でんわ}をかける: to make a call
- {電話|でんわ}に{出|で}る: to answer the phone
- {電話|でんわ}を{切|き}る: to hang up
- {電話|でんわ}{番号|ばんごう}: phone number

Note: {携帯|けいたい}{電話|でんわ} (mobile phone) is often shortened to {携帯|けいたい} or ケータイ in casual speech.
```

### Example 3: Simple Entry

```
ここ refers to a location near the speaker. It's part of the ko-so-a-do demonstrative system.

Related words:
- そこ: there (near listener)
- あそこ: over there (far from both)
- どこ: where (question)
```

## Notes on Web Display

The web interface renders notes with line break support. To ensure proper display:

1. Use `\n\n` (double newline) between paragraphs/sections
2. Use `\n` (single newline) before each bullet point
3. Bullet points with `- ` will display as a list

The rendering converts newlines appropriately, so focus on logical structure in the JSON.

