Jetbrains Writerside - integrált dokumentumszerkesztés

2023-11-08 09:00
Az early access programban már elérhető a Jetbrains legújabb, műszaki dokumentációkészítéshez készült szoftvere.

A Jetbrains a blogján bejelentette, hogy több mint két évnyi fejlesztés után elindult a Writerside műszaki dokumentációkészítő alkalmazás tesztelhetősége, az Early Access Program keretében. 

A Writerside lehetőségei:

Docs-as-code pipeline

Használjon egyetlen authoring környezetet - így nincs szükség többféle eszközre. A beépített Git felhasználói felülettel, az integrált build tool-al, az automatizált tesztekkel, valamint a testreszabható felülettel arra koncentrálhat, ami a legfontosabb - a tartalomra.

Markdown és XML kombinálva

A Markdown és a szemantikus jelölés előnyeit kombinálhatja. Kötődhetünk akár csak az egyik formátumhoz, de gazdagíthatjuk a markdown formátumot szemantikus attribútumokkal és elemekkel, Mermaid-diagramokkal és LaTeX matematikai képletekkel.

Dokumentumok minőségének automatizálása

A dokumentáció minőségét és integritását a szerkesztőben található több mint 100 azonnali ellenőrzés biztosítja, mindezt a Live Preview-ban és a build során végzett tesztekkel.

Live Preview

Az előnézet pontosan úgy mutatja a dokumentumokat, ahogyan az olvasói látni fogják. Előnézetben megtekinthet egyetlen oldalt az IDE-ben, vagy megnyithatja a teljes súgó-weboldalt a böngészőben a build futtatása nélkül.

Egyetlen forrás

Bármit újrahasznosíthat, a kisebb tartalmi daraboktól kezdve a teljes témakörökig vagy a tartalomjegyzék szakaszaiig. Maradjon rugalmas a szűrőkkel és változókkal. Használjon előre definiált sablonokat az összetett markup elemek használatához, vagy konfiguráljon sajátot.

REST API dokumentáció generálása

Nem kell többé különböző eszközök között ugrálnia a felhasználói dokumentáció és az API-hivatkozások létrehozásakor. Mostantól az API-dokumentumokat beépítheti a súgó webhelyébe, ugyanabban az elrendezésben közzéteheti, és az automatikusan generált hivatkozásokat kézzel írt tartalommal egészítheti ki.

Igazi dokumentumkészítők által készített...a dokumentaristáknak

Ez a projekt több száz ügyfélinterjú és az IntelliJ Platform dokumentációján végzett több mint 10 éves munka eredményeként alakult ki. Ezek a tapasztalatok hosszú listát adtak nekünk az építendő funkciókról és megoldandó problémákról. Azért vagyunk itt, hogy egyenként foglalkozzunk velük.


Próbáld ki a Writerside-ot, és mondd el a véleményed!

Olvass tovább

, ,
KreaCon 2025: A kreatív szakma új konferenciája Budapesten!

A KreaCon 2025 kreatív konferencia Budapest egy teljesen új esemény a kreatív szakemberek számára, amely előadásokkal, workshopokkal és inspiráló programokkal várja a résztvevőket november 14-én a Lurdy Házban.

,
16 világsztár kreatív szakember ad elő a KreaCon 2025-ön

Ismerd meg a KreaCon 2025 előadóit! 16 nemzetközileg elismert szakember áll színpadra november 14-én a kreatív ipar képviseletében.


Profi videoszerkesztés az iPhone-okon Adobe Premiererrel

Vége azoknak az időknek, amikor muszáj volt visszatérni az asztali géphez. Az Adobe Premiere új iPhone alkalmazása stúdió minőségű videoszerkesztést hoz el közvetlenül a zsebedbe - ingyen.

Copyright © 2023 Trans-Europe Zrt. Minden jog fenntartva.
linkedin facebook pinterest youtube rss twitter instagram facebook-blank rss-blank linkedin-blank pinterest youtube twitter instagram