msf-documentation
/msf-documentation
Przygotowuje README, instrukcje dla użytkowników i administratorów, OpenAPI, opisy wdrożenia oraz informacje o wydaniach.
- Autor
- Mustafa1998-tech ↗
- Repozytorium
- msf-skills ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 12.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 2
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 1
Brak sygnałów. Repozytorium zmienione 12.11.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Przygotowuje README, instrukcje dla użytkowników i administratorów, OpenAPI, opisy wdrożenia oraz informacje o wydaniach.
Oryginalny opis (EN)
Use for READMEs, user/admin manuals, OpenAPI, architecture, installs, deployment, troubleshooting, changelogs or release notes.
Jak działa
- Scope
- Inputs
- Prerequisites
- Workflow
- Safety
- Outputs
- Validation
- Failure handling
- References
Podgląd SKILL.md
--- name: msf-documentation description: "Use for READMEs, user/admin manuals, OpenAPI, architecture, installs, deployment, troubleshooting, changelogs or release notes." --- # msf-documentation ## Scope Use for READMEs, user/admin manuals, OpenAPI, architecture, installs, deployment, troubleshooting, changelogs or release notes. ## Inputs Audience, current build or UI, repository, API schema, languages and target deployment. ## Prerequisites Inspect actual commands, entry points, error responses and artifact versions. Use safe screenshots or synthetic examples. ## Workflow 1. Organize by reader task. Document prerequisites, a minimal quick start, verification, update/uninstall or rollback and troubleshooting based on observable symptoms. Explain parameters, exit states and roles. 2. For APIs reconcile OpenAPI with actual routes and examples; distinguish deployment and management procedures from everyday user steps. Pair Arabic and English by section and preserve identifiers and commands. Trace release notes to verified changes. ## Safety Redact account details and secrets. Avoid licensing claims without evidence; label planned features and environment-dependent checks explicitly. ## Outputs Bilingual docs, runnable snippets, license/source links, versioned changelog and release notes. ## Validation Run example commands where feasible, validate local links, compare parity and verify claims against outputs. Show output state with evidence. ## Failure handling If a tool or app is unavailable, label the procedure unverified and record the exact validation step. ## References - [Field guide](references/field-guide.md) - [Primary source](https://spec.openapis.org/oas/latest.html)
Pliki w paczce (2)
- SKILL.md 2 KB
- references/field-guide.md 1 KB
Wersje
W bazie nie ma innych skilli o nazwie msf-documentation.
Migawka bazy z 13.11.2026 · wersja paczki 6ee415e9b6e5 (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
- 100documentation-patterns
Opisuje wzorce dokumentacji technicznej dla README, ADR, API w OpenAPI 3.1, changelogów i przewodników stylu pisania. - 100documentation-patterns
Podaje wzorce dokumentacji technicznej: README, ADR, changelogi, API w OpenAPI 3.1 i styl pisania przy tworzeniu dokumentacji projektu. - 90msf-testing
Pomaga w testach jednostkowych, integracyjnych, API, przeglądarkowych, dostępności, regresji wizualnej i responsywności oraz CRUD. - 90Technical Writing
Pisze dokumentację techniczną: ADR, RFC, README, referencje API, poradniki, runbooki i notatki o wydaniach oraz sprawdza ich poprawność. - 100msf-architecture
Pomaga projektować granice systemu, moduły, integracje i dług techniczny, dobierając złożoność do wielkości systemu. - 100documentation-generation
Generuje dokumentację projektu: README, docstringi (JSDoc, JavaDoc, Python), opisy OpenAPI i potoki dokumentacji w CI/CD.