Tech Writer koduje odcinek 22

Dziś kilka słów na temat ostatniego odcinka podcastu Tech Writer koduje.

W najnowszym odcinku Michał Skowron i Paweł Kowaluk dyskutują na temat wykorzystania narzędzia Next.js w tworzeniu dokumentacji API.

Z rozmowy możemy dowiedzieć się czym jest wspomniane narzędzie oraz do czego można je wykorzystać. Poza tym, Paweł wspomina o darmowym tutorialu, dzięki któremu w prosty sposób można poznać główną funkcję Next.js, a mianowicie tworzenie nowoczesnych stron internetowych, a także stron statycznych.

A co Next.js może zaoferować Tech Writerom?

Paweł używa go w tworzeniu dokumentacji API łącząc go z narzędziem ReDoc. Celem takiego połączenia jest stworzenie jednej strony, w której będzie znajdowała się dokumentacja dla wielu API napisanych przy pomocy specyfikacji OpenAPI. Przy okazji tego problemu możecie dowiedzieć się nieco na temat wyzwań stojących przed twórcami dokumentacji. Głównym z nich jest fakt, że istnieje wiele specyfikacji API, które trzeba opublikować. Swagger UI nie spełnia wymagań projektu, bo pomija customowe tagi i ładuje się zbyt wolno. Trzeba więc znaleźć coś co pozwoli nam opublikować dokumentację do wszystkich specyfikacji na jednej stronie. Należy pamiętać, że musimy to robić w sposób powtarzalny dla kolejnych wersji. I musimy spełnić wymagania używalności dokumentacji.

Takie zadania to woda na młyn Tech Writera, który majsterkuje przy kodzie!

Next.js to framework Reacta, dzięki któremu można w elastyczny sposób tworzyć nowoczesne strony internetowe. Według rankingu na stronie staticgen.com, jest to również jeden z najpopularniejszych generatorów stron statycznych.

Na koniec kilka bonusowych pomysłów na inne wykorzystanie Next.js. Zdaniem Michała i Pawła, narzędzie to może nam się przydać kiedy piszemy dokumentację w standardzie DITA. A jak to zrobić? Posłuchajcie sami 😉