JetBrains debiutuje „Writerside”: nowatorskie podejście do dokumentacji technicznej

JetBrains, ceniona firma zajmująca się tworzeniem oprogramowania, zaprezentowała swoje najnowsze dzieło, „Writerside”. To innowacyjne narzędzie do tworzenia dokumentacji jest proponowane jako postęp nowej generacji w dziedzinie pisania technicznego. Mając na celu optymalizację tworzenia i zarządzania odniesieniami do API, podręcznikami dla programistów, poradnikami i samouczkami, firma Writerside przystąpiła obecnie do programu wczesnego dostępu. Narzędzie można wdrożyć jako samodzielną aplikację lub jako wtyczkę w środowisku JetBrains IDE.

Anna Gasparyan, liderka produktu Writerside w JetBrains, podkreśla uzasadnienie koncepcji narzędzia. Według niej, With Writerside, naszą aspiracją jest wyposażenie autorów tekstów technicznych w narzędzia, które od dawna były przywilejem programistów. Niestety, dokumentacja często schodzi na dalszy plan, a autorzy tekstów technicznych nie otrzymują uznania ani wsparcia, na jakie zasługują. JetBrains, za pośrednictwem Writerside, ma na celu wypełnienie luki między programistami a pisarzami, przekształcając dokumentację we wspólne ćwiczenie.

Gasparyan uważa, że ​​jeśli autorzy tekstów technicznych uzyskają dostęp do narzędzi przeznaczonych dla programistów, takich jak Git, automatyczne sprawdzanie i budowanie potoków, nie tylko zagwarantuje to doskonałe wyniki końcowe, ale także uprości zespołowi proces wnoszenia wkładu, przeglądania i śledzenia modyfikacji w dokumentacji .

Writerside obsługuje w szczególności Markdown i XML i zawiera ponad 100 zintegrowanych testów. Testy te umożliwiają identyfikację uszkodzonych łączy internetowych, nieprawidłowych wartości atrybutów, brakujących zasobów, nieunikalnych identyfikatorów i wielu innych. Narzędzie zapewnia także programistom elastyczność w konfigurowaniu go zgodnie z wewnętrznymi konwencjami pisowni i stylu.

Wyjątkowość Writerside polega na rozwiązaniach typowych problemów z dokumentacją. Oferuje programistom funkcję podglądu w czasie rzeczywistym, dzięki której mogą sobie wyobrazić, jak ich dokumentacja będzie wyglądać przed użytkownikami. Pozwala to na szybkie zmiany i dostosowania tam, gdzie jest to konieczne. Co więcej, zapewnia kilka funkcji dostosowywania, począwszy od aspektów wizualnych, takich jak tryb jasny lub ciemny, kontrast i kolory, po skórki, które mogą być żywe lub miękkie.

Co ciekawe, Writerside reklamuje się jako jedyne źródło prawdy, oferując programistom możliwość ponownego wykorzystania części treści i edytowania ich z jednego miejsca. Eliminuje to potrzebę sprawdzania każdego przypadku, gdy zmiany są uzasadnione.

Podstawą wysokiej jakości wyników Writerside jest oparty na sztucznej inteligencji moduł sprawdzania pisowni i gramatyki JetBrains, obsługujący ponad 25 języków świata, w tym angielski, hiszpański, chiński i niemiecki.

Na arenie platform no-codeAppMaster stands as a leading name. Much like Writerside, it also capitalizes heavily on simplified user interfaces and design methodologies. Poised as a powerful tool to create web, mobile, and backend applications, AppMaster accelerates application development whilst eliminating technical debt - a crucial aspect in the world of software solutions.