O usłudze
PrzetłumaczoneJestem pisarzem technicznym i przekształcam rozproszone materiały w dokumentację, której zarówno programiści, jak i zwykli użytkownicy ufają. Pracuję bezpośrednio z twoim kodem, pull requestami, kolekcjami Postmana, rozmowami na messengerze i krótkimi rozmowami z inżynierami, dostarczając czysty, uporządkowany tekst, który wyjaśnia nie tylko, co robi funkcja, ale także dlaczego i kiedy ją zastosować. Moim celem jest dokumentacja dla programistów, referencje API, przewodniki integracyjne, instrukcje dla użytkowników i administratorów, artykuły jak to zrobić. Dokładność jest dla mnie najważniejsza: weryfikuję każdy punkt końcowy, parametr, kod odpowiedzi i komunikat o błędzie w odniesieniu do rzeczywistego produktu przed publikacją, aby czytelnicy nie napotkali kroku, który cicho nie działa.
Oferuję więcej niż tylko tekst po korekcie. Myślę o strukturze: co powinno trafić do szybkiego startu, a co do referencji, piszę w jednolitym tonie i dostarczam wielokrotnego użytku przewodnik stylu. Dostarczam w Markdown, reStructuredText, AsciiDoc lub bezpośrednio do twojego pipeline'u docs-as-code, swobodnie pracuję z Git, specyfikacjami OpenAPI i Swagger, generatorami statycznych stron i narzędziami do diagramów. Dodaję skomentowane przykłady kodu, przykładowe żądania i odpowiedzi, diagramy sekwencji i zrzuty ekranu tam, gdzie mają największe znaczenie, i wszystko wersjonuję, aby aktualizacje były łatwe.
Niezależnie od tego, czy uruchamiasz publiczne API, wprowadzasz nowe SDK, czy w końcu dokumentujesz wewnętrzne narzędzie, które istnieje w głowie jednego inżyniera — ocenię zakres, zbiorę wymagania od interesariuszy i dostarczę kompletny pakiet dokumentacji na czas. Wyślij mi to, co masz, a szczerze powiem ci, co brakuje i jak wypełnić luki.
— Dokumentacja dla programistów i przewodniki szybkiego startu
— Referencje API REST i GraphQL z specyfikacji OpenAPI/Swagger
— Przewodniki użytkownika, przewodniki dla administratorów i artykuły jak to zrobić
— Docs-as-code w Markdown, reST lub AsciiDoc z Gitem
— Edytowanie, restrukturyzacja i przewodniki stylu dla istniejącej dokumentacji
Oferuję więcej niż tylko tekst po korekcie. Myślę o strukturze: co powinno trafić do szybkiego startu, a co do referencji, piszę w jednolitym tonie i dostarczam wielokrotnego użytku przewodnik stylu. Dostarczam w Markdown, reStructuredText, AsciiDoc lub bezpośrednio do twojego pipeline'u docs-as-code, swobodnie pracuję z Git, specyfikacjami OpenAPI i Swagger, generatorami statycznych stron i narzędziami do diagramów. Dodaję skomentowane przykłady kodu, przykładowe żądania i odpowiedzi, diagramy sekwencji i zrzuty ekranu tam, gdzie mają największe znaczenie, i wszystko wersjonuję, aby aktualizacje były łatwe.
Niezależnie od tego, czy uruchamiasz publiczne API, wprowadzasz nowe SDK, czy w końcu dokumentujesz wewnętrzne narzędzie, które istnieje w głowie jednego inżyniera — ocenię zakres, zbiorę wymagania od interesariuszy i dostarczę kompletny pakiet dokumentacji na czas. Wyślij mi to, co masz, a szczerze powiem ci, co brakuje i jak wypełnić luki.
— Dokumentacja dla programistów i przewodniki szybkiego startu
— Referencje API REST i GraphQL z specyfikacji OpenAPI/Swagger
— Przewodniki użytkownika, przewodniki dla administratorów i artykuły jak to zrobić
— Docs-as-code w Markdown, reST lub AsciiDoc z Gitem
— Edytowanie, restrukturyzacja i przewodniki stylu dla istniejącej dokumentacji
