Rozwijać Integrować
Budować na produkcie, rozszerzać lub integrować go, aby tworzyć dodatkową wartość.
Użytkownicy często muszą budować na istniejących produktach, rozszerzać je lub integrować z innymi rozwiązaniami. Nie chodzi wyłącznie o programowanie, lecz o tworzenie dodatkowej wartości na bazie głównego produktu — poprzez integracje, rozszerzenia, wtyczki albo zupełnie nowe aplikacje.
Przykłady dokumentacji wspierającej dalszy rozwój produktu to Vercel Approval Checklist oraz przewodnik Chrome Debug extensions. Zauważmy, że nacisk jest prawie zawsze praktyczny, a rodzaj treści ma drugorzędne znaczenie. Wiele materiałów o integracjach i rozszerzeniach przyjmuje postać poradników, a nawet artykułów.
Dokumentacja skupiona na potrzebach rozwoju lub integracji tworzy pomost między obecnymi możliwościami produktu a jego potencjałem. Zmienia użytkowników we współtwórców i wspiera rozwój ekosystemu. Ten typ dokumentacji często staje się podstawą społeczności praktyków.
Co użytkownik chce zrobić
Użytkownicy często muszą budować na istniejących produktach, rozszerzać je lub integrować — poprzez integracje, rozszerzenia, wtyczki albo zupełnie nowe aplikacje. Nacisk jest prawie zawsze praktyczny.
Sygnały, że dokumentacja tego nie zapewnia
- Pytania dotyczące integracji i rozszerzeń pozostają bez odpowiedzi albo są odsyłane na forum.
- Brakuje przewodnika po budowaniu rozwiązań na bazie produktu.
- Punkty rozszerzeń produktu nie są udokumentowane.
Dwa przykłady z praktyki
Typowe rodzaje treści
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <task>, <codeblock>, <coderef> | Poradnik | Poradnik, Dokumentacja API |
Jedna metryka
wzrost ekosystemu · Liczba integracji lub rozszerzeń utworzonych przez użytkowników.