nk-documentation-best-practices

Installation
SKILL.md

NK Documentation Best Practices

Shared documentation rules across all Naykel projects. Project-specific skills extend this one — apply both, with the project skill taking precedence where they conflict.

Review Workflow

  • Mark every new heading with (review) until its content is confirmed.
  • When you update a section carrying (review), ask whether that section is complete.
  • On confirmation: remove the (review) tag and update the project status file.
  • Remove (wip) from the nav entry once the doc's structure is agreed, even if some sections still carry (review).
  • Leave (review) on any headings that are still unresolved.
  • When all (review) tags are gone from a doc, it is considered complete.
  • When closing documentation work, call out which headings or docs still carry (review) tags.
Installs
45
First Seen
Apr 27, 2026