Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

arch-docs

/arch-docs

Tworzy lub odświeża docs/CODE_ARCHITECTURE.md i docs/FILE_STRUCTURE.md na podstawie dowodów z repozytorium, opisując architekturę kodu i układ plików.

Repozytorium
vosslab-skills ↗
Licencja
MIT
Ostatnia zmiana repozytorium
22.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
2
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 22.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 lub odświeża docs/CODE_ARCHITECTURE.md i docs/FILE_STRUCTURE.md na podstawie dowodów z repozytorium, opisując architekturę kodu i układ plików.

Oryginalny opis (EN)

Create or refresh `docs/CODE_ARCHITECTURE.md` and `docs/FILE_STRUCTURE.md` from repository evidence. Use for architecture or file-layout documentation. Use other documentation skills for README, installation, usage, or repo-wide updates.

Jak działa

  1. Overview
  2. Workflow
  3. Repository structure
  4. Notes
  5. Example requests
Sekcje z nagłówków SKILL.md, w oryginale · 100 linii, 586 słów
Podgląd SKILL.md
---
name: arch-docs
description: "Create or refresh `docs/CODE_ARCHITECTURE.md` and `docs/FILE_STRUCTURE.md` from repository evidence. Use for architecture or file-layout documentation. Use other documentation skills for README, installation, usage, or repo-wide updates."
---

# Arch docs

## Overview

Create or refresh architecture and file-structure documentation from the current repo state.
Base statements on observable files and configs, and record unknowns as verification tasks.

## Workflow

1. Inspect the repo
   - Read `README.md` and `AGENTS.md`.
   - Scan layout with `ls -1` and `ls -1 ./docs/`.
   - Use `rg --files` to get a fuller inventory when needed.
   - Identify languages, build tooling, entry points, and main executables.
   - Check common manifests (`pyproject.toml`, `pip_requirements.txt`, `package.json`,
     `Cargo.toml`, `go.mod`, `Makefile`) when present.
   - Locate core logic, scripts, and tests.
   - Check `.gitignore` for generated artifacts and caches.
   - Run `git status -suno` to see uncommitted changes.
2. Update policy
   - Remove stale details.
   - Keep accurate sections and restructure for clarity when needed.
   - State facts only; do not invent details.
   - If unclear, add a verification task in the "Known gaps" section.
3. Apply style and consistency
   - Follow `docs/MARKDOWN_STYLE.md` and `docs/REPO_STYLE.md`.
   - Use present tense, concrete paths, and relative links.
   - Link file and folder names to their repo paths when mentioned, so they are
     clickable for details. Markdown links are created using the syntax
     `[link text](URL)`, where "link text" is the clickable text that appears in
     the document, and "URL" is the web address or file path the link points to.
     This allows users to navigate between different content easily. Use file-path
     link text so readers know the exact filename (good:
     `[docs/MARKDOWN_STYLE.md](docs/MARKDOWN_STYLE.md)`, bad:
     `[Style Guide for Markdown](docs/MARKDOWN_STYLE.md)`). Only include a
     backticked path when the link text is not the path.
   - Prefer short, scannable bullets.
   - Only include commands verifiable from repo files.
   - Avoid non-ASCII characters unless explicitly required by existing docs.
   - Prefer ISO-8859-1 only when the repo already uses it.
4. Write `docs/CODE_ARCHITECTURE.md`
   - Title: "Code architecture"
   - Sections to include when applicable:
     - Overview
     - Major components (what, where, key dependencies)
     - Data flow (primary use case end-to-end)
     - Testing and verification (only if verifiable)
     - Extension points (where to add code/modules/integrations)
     - Known gaps (verification tasks only)
5. Write `docs/FILE_STRUCTURE.md`
   - Title: "File structure"
   - Sections to include when applicable:
     - Top-level layout (key dirs/files with one-line purpose)
     - Key subtrees (large directories that need clarification)
     - Generated artifacts (what/where/git ignored)
     - Documentation map (docs location and root docs)
     - Where to add new work (code/tests/docs/scripts/data)

## Repository structure

When showing a directory tree, use ASCII only. Do not use box drawing characters.

- Allowed: `|`, `+-`, `` `-``, spaces
- Not allowed: box-drawing characters such as U+251C, U+2500, U+2502, U+2514

Example (ASCII only):

```text
site_docs/
+- index.md
+- biochemistry/
|  `- topic01/
|     `- index.md
`- genetics/
   `- topic01/
      `- index.md
mkdocs.yml
```

6. Wrap up
   - Save both files.
   - Leave `README.md` to `readme-docs`, the sole owner of README content. It links
     `docs/CODE_ARCHITECTURE.md` and `docs/FILE_STRUCTURE.md` from README once they
     exist. This skill owns only the two architecture docs.
   - Update `docs/CHANGELOG.md` directly when this skill runs as a standalone task; under `delegate-manager-to-subagents`, dispatch a docs subagent to add the entry.
   - Summarize what changed and what could not be verified.
   - Note that docs-only changes do not require tests unless otherwise requested.

## Notes

- Prefer to trim and correct existing docs before rewriting from scratch.
- If the repo lacks needed evidence, add a "Known gaps" bullet with a verification task.

## Example requests

- "Update the architecture and file structure docs for this repo."
- "Create CODE_ARCHITECTURE.md and FILE_STRUCTURE.md based on current files."
- "Refresh the docs/FILE_STRUCTURE.md map after adding new folders."
Pliki w paczce (2)
  • SKILL.md 4 KB
  • agents/openai.yaml 1 KB

Wersje

W bazie nie ma innych skilli o nazwie arch-docs.

Migawka bazy z 13.11.2026 · wersja paczki 383139aa4dc7 (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

  • 100setup-install-usage-docs
    Tworzy lub odświeża docs/INSTALL.md i docs/USAGE.md na podstawie dowodów z repozytorium, gdy dokumentacja jest brakująca lub nieaktualna.
  • 100repo
    Aktualizuje dokumentację repozytorium, czyli README, docs i CLAUDE.md, na podstawie zmian z sesji.
  • 100readme-generator-free
    Generuje README, dokumentację instalacji i użycia oraz odznaki dla projektu na podstawie istniejącego kodu.
  • 100docs-refresh
    Odświeża dokumentację deterministyczną generacją z plików źródłowych, uruchamianą poleceniem /docs-refresh.
  • 90generate-readme
    Tworzy lub odświeża README repozytorium, z opisem architektury, diagramami, strukturą katalogów, zależnościami i dokumentacją API.
  • 100generating-project-docs
    Tworzy i odświeża dokumentację projektu: README.md, ARCHITECTURE.md, STRUCTURE.md oraz aktualizacje wybranych sekcji.

Uwagi i zgłoszenia

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