Przejdź do treści
Biblioteka skilli
Dokumenty i biuro · Automatyzacja

setup-doc-conventions

/setup-doc-conventions

Tworzy szablony dokumentacji, dashboard.md i konfigurację Obsidian oraz dopisuje do CLAUDE.md sekcję o pracy z dokumentami.

Repozytorium
mstack ↗
Licencja
MIT
Ostatnia zmiana repozytorium
12.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 12.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Tworzy szablony dokumentacji, dashboard.md i konfigurację Obsidian oraz dopisuje do CLAUDE.md sekcję o pracy z dokumentami.

Wyzwalacze z opisu

set up doc conventions\bootstrap docs\install doc-conventions\set up the docs folder\
Oryginalny opis (EN)

Bootstrap doc-conventions in the current project: creates docs/templates/ (including dashboard.base), docs/dashboard.md, configures Obsidian, and appends a workflow section to CLAUDE.md. Use when the user says \"set up doc conventions\", \"bootstrap docs\", \"install doc-conventions\", or \"set up the docs folder\".

Jak działa

  1. 1. Create directory structure
  2. 2. Copy templates
  3. 3. Configure Obsidian
  4. 4. Update CLAUDE.md
  5. 5. Commit
  6. 6. Verify
Sekcje z nagłówków SKILL.md, w oryginale · 74 linii, 288 słów
Podgląd SKILL.md
---
name: setup-doc-conventions
description: "Bootstrap doc-conventions in the current project: creates docs/templates/ (including dashboard.base), docs/dashboard.md, configures Obsidian, and appends a workflow section to CLAUDE.md. Use when the user says \"set up doc conventions\", \"bootstrap docs\", \"install doc-conventions\", or \"set up the docs folder\"."
---

Set up the doc-conventions system in this project. Follow these steps exactly:

## 1. Create directory structure

```bash
mkdir -p docs/templates
```

## 2. Copy templates

Copy all 10 doc type templates and dashboard.base from the dev plugin cache into `docs/templates/`:
- design.md, impl-plan.md, cutover-plan.md, analysis.md, report.md, postmortem.md, kb.md, ops-guide.md, playbook.md, experiment.md
- dashboard.base (Obsidian Bases views definition — stays in templates/)

Then copy dashboard.md into `docs/dashboard.md` (the entry point that transcludes named views from templates/dashboard.base).

Find the plugin cache at: `~/.claude/plugins/cache/mstack/dev/*/templates/`

```bash
PLUGIN_DIR=$(ls -d ~/.claude/plugins/cache/mstack/dev/*/templates/ 2>/dev/null | head -1)
if [[ -n "$PLUGIN_DIR" ]]; then
  cp "$PLUGIN_DIR"/{design,impl-plan,experiment,cutover-plan,analysis,report,postmortem,kb,ops-guide,playbook}.md docs/templates/
  cp "$PLUGIN_DIR/dashboard.base" docs/templates/dashboard.base
  cp "$PLUGIN_DIR/dashboard.md" docs/dashboard.md
else
  echo "Plugin cache not found. Copy templates manually."
fi
```

## 3. Configure Obsidian

If `docs/.obsidian/` exists, update `docs/.obsidian/app.json` to include:
```json
{
  "templateFolder": "templates"
}
```

If `docs/.obsidian/` doesn't exist, create it:
```bash
mkdir -p docs/.obsidian
echo '{"templateFolder": "templates"}' > docs/.obsidian/app.json
```

Ensure the Templates core plugin is enabled in `docs/.obsidian/core-plugins.json`.

## 4. Update CLAUDE.md

Read the workflow section template from:
```bash
TMPL_DIR=$(ls -d ~/.claude/plugins/cache/mstack/dev/*/templates/ 2>/dev/null | head -1)
```

Append the contents of `$TMPL_DIR/claude-md-workflow-section.md` to the project's `CLAUDE.md`.

If CLAUDE.md doesn't exist, create it with just the workflow section.

## 5. Commit

```bash
git add docs/ CLAUDE.md
git commit -m "feat: set up doc-conventions (templates, dashboard, workflow)"
```

## 6. Verify

- Run `ls docs/templates/` — should show 10 template files + dashboard.base
- Run `cat docs/dashboard.md` — should show Obsidian transclusion links to dashboard.base views
- Run `cat docs/templates/dashboard.base` — should show Obsidian Bases view definitions
- Open docs/ in Obsidian — dashboard.md should render with tabbed views, templates should be available

Note: Hooks are registered automatically by the dev plugin via `hooks.json`. No project-level hook configuration is needed.

Wersje

W bazie nie ma innych skilli o nazwie setup-doc-conventions.

Migawka bazy z 13.11.2026 · wersja paczki fc45da817d49 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100route-docs
    Zmienia miejsce przechowywania dokumentacji projektu: pliki lokalne, vault Obsidian, przestrzeń Notion lub podział według typu, i odtwarza szkielet dokumentów zgodnie z nowym wyborem.
  • 100pm
    Zarządza zadaniami i dokumentami w vaulcie Obsidian: dodaje zadania, tworzy dokumenty, archiwizuje, listuje zadania w toku, odświeża dashboard i dzieli specyfikacje na tickety.
  • 85write-the-docs
    Pisze lub edytuje dokumentację projektu: README, dokumenty projektowe i opisy modułów.
  • 100setup-project
    Buduje w projekcie strukturę Claude Agent Pack: CLAUDE.md, CONVENTIONS.md, MEMORY-WRITING.md i katalogi pamięci.
  • 100skill-doc-sync
    Synchronizuje dokumentację projektu w markdownie po wdrożeniu zmian, np. przy aktualizacji dokumentów i notatkach do wydania.
  • 90update-doc
    Aktualizuje istniejący plik dokumentacji w .chalk/docs/, gdy użytkownik prosi o zmianę, edycję lub rewizję dokumentu.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.