Model dokumentacji oparty na siedmiu działaniach
Model tego, czego czytelnicy potrzebują od dokumentacji, a nie tego, jakie treści należy pisać.
Siedem działań
Opisowy model potrzeb użytkowników dokumentacji technicznej. Siedem działań obejmuje cele, które odbiorca dokumentacji może chcieć osiągnąć: ocenić, zrozumieć, eksplorować, ćwiczyć, przypomnieć sobie, rozwijać i rozwiązywać problemy.
- Ocenić Rozpoznać
- Rozpoznać główne cechy produktu i, jeśli ma to zastosowanie, porównać go z innymi.
- Zrozumieć Nauczyć się
- Pojąć abstrakcje i modele mentalne, na których opiera się produkt.
- Eksplorować Odkrywać
- Wypróbować produkt i odkryć jego możliwości przy niskiej barierze wejścia.
- Ćwiczyć Trenować
- Nauczyć się codziennej, standardowej obsługi produktu.
- Przypomnieć sobie Przywołać
- Przywołać informacje, których nie dało się zapamiętać — od parametrów po kody błędów.
- Rozwijać Integrować
- Budować na produkcie, rozszerzać lub integrować go, aby tworzyć dodatkową wartość.
- Rozwiązywać problemy Rozwiązać
- Sprawnie diagnozować i rozwiązywać problemy, często pod presją.
Dla agentów
- Wprowadzenie — Dlaczego powstał model dokumentacji oparty na siedmiu działaniach.
- Słownik pojęć — Wszystkie pojęcia modelu: siedem działań, ich alternatywne czasowniki i znaczenie każdego z nich.
- Skill modelu dokumentacji opartego na siedmiu działaniach — Zainstaluj skill agenta do planowania i ulepszania dokumentacji za pomocą modelu siedmiu działań.
- Wersje Markdown — Każda strona jest również dostępna jako index.md.
- model.json — Model do odczytu maszynowego
- llms.txt — Indeks witryny dla modeli językowych
- sitemap.md — Mapa witryny
- AGENTS.md — Jak agenci powinni czytać tę witrynę
Model dokumentacji oparty na siedmiu działaniach · 2025-01-09 · CC BY 4.0 · Wprowadzenie · Fabrizio Ferri Benedetti