Dokumenty jako kod: nowoczesne pisanie techniczne przy użyciu przepływów pracy programisty

Dokumentacja techniczna jest najbardziej skuteczna, gdy jest tworzona równolegle z oprogramowaniem, które opisuje.Zastosowanie obiegu pracy Dokumenty jako kod umożliwia autorom, programistom i twórcom treści płynną współpracę przy użyciu tych samych narzędzi i środowisk. Ten kurs tekstowy przeprowadzi Cię przez podstawowe koncepcje Dokumentów jako kodu, zmieniając sposób pisania, przeglądania i publikowania treści technicznych.Będziesz przechodzić od tradycyjnych edytorów tekstu do zautomatyzowanych potoków dokumentacji kontrolowanych wersją. Co się nauczysz: Zrozumienie podstawowych zasad i korzyści płynących z filozofii Docs-as-Code; Pisanie uporządkowanej zawartości przy użyciu lekkich języków znaczników, takich jak Markdown; Zarządzanie wersjami dokumentów i współpraca przy użycia przepływów pracy Git; Konfigurowanie automatycznego sprawdzania i sprawdzania stylu w celu utrzymania jakości dokumentu; Poznaj generatory i narzędzia statycznej witryny Zastosuj najlepsze praktyki pisania technicznego do interfejsów API, usług oprogramowania i postów na blogu.Zaczniesz od podstawowej terminologii i podstawowych pojęć, zanim przejdziesz do przewodników krok po kroku dotyczących konfigurowania środowiska pisania, śledzenia zmian i automatyzacji obiegu pracy publikowania. Ten kurs jest przeznaczony dla początkujących, aspirujących pisarzy technicznych i programistów, którzy chcą nauczyć się nowoczesnych przepływów pracy dokumentacji, bez wcześniejszego doświadczenia w programowaniu.Zacznij czytać już dziś, aby zbudować wydajne, przyjazne dla programistycznych przepływy pracy dokumentacyjne.