Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

PKM Documentation Skill

Personal Knowledge Management system based on Zettelkasten principles, adapted for AI agent workspaces. Provides atomic, connected, template-driven documentation.

Install

Option 1: Using npx (recommended)

npx skills add balin-ar/pkm-documentation

Option 2: Manual

Add this skill to your workspace:

skills/pkm-documentation/

Setup

From your workspace root, run:

bash skills/pkm-documentation/scripts/setup.sh

This is idempotent — safe to run multiple times.

What Setup Does

  1. Creates knowledge/ directory with subdirectories: decisions/, devlog/, learnings/, projects/, conversations/, daily/, plus a README.md vault map.

  2. Patches AGENTS.md — appends a PKM section with vault structure, documentation triggers, and key rules.

  3. Patches SOUL.md — appends a Documentation section establishing PKM as the agent's nervous system.

  4. Patches MEMORY.md — appends a PKM System section with skill location and vault reference.

All injected sections are wrapped in <!-- PKM-START --> / <!-- PKM-END --> markers for clean removal.

Customization

After setup, edit the injected sections directly in your AGENTS.md, SOUL.md, or MEMORY.md. The <!-- PKM-START/END --> markers are only used by the uninstall script — feel free to modify content between them or remove the markers if you don't plan to uninstall.

You can also:

  • Add/remove knowledge subdirectories
  • Modify templates in SKILL.md
  • Change naming conventions

Uninstall

bash skills/pkm-documentation/scripts/uninstall.sh

This removes the PKM sections from AGENTS.md, SOUL.md, and MEMORY.md. It will ask before deleting the knowledge/ directory.

Usage

See SKILL.md for the full documentation system: templates, workflows, and conventions.

About

PKM Documentation skill for AI agents — Zettelkasten-based knowledge vault with atomic notes, wiki-links, and standardized templates

Resources

Stars

10 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages