Příběh nového webu dokumentace 4D založeného na formátu Markdown

Arnaud Schmitt, vedoucí technické dokumentace ve společnosti 4D SAS

Jak mnozí z vás vědí, server doc.4d.com je již dlouho spravován pomocí interní aplikace 4D. V současné době však dokumentace 4D přechází na novou architekturu: dokumentační web založený na Markdown.

Tomuto tématu jsem se věnoval před několika týdny na setkání 4D Method, kde jsem se podělil o naše zkušenosti s vytvářením a údržbou nového dokumentačního webu. Tyto informace se vám mohou hodit při procházení webu s dokumentací 4D, nebo pokud potřebujete vytvořit vlastní dokumentaci.

Proč nový dokumentační web?

Inu, předchozí dokumentační web 4D je stále živý a velmi užitečný, ale je zastaralý a jeho vývoj bývá náročný kvůli starému kódu. Takže jsme chtěli následující:

• nový design pro nové technologie,
• způsob dokumentace API s třídami, dědičností, hierarchií atd.
• mít větší kontrolu nad formáty, styly, sestaveními atd.

V tomto videu podrobně vysvětluji důvody tohoto přechodu, celkovou architekturu a mnoho dalšího:

Neváhejte se ke mně připojit na fóru 4D, pokud máte nějaké dotazy.

Co je to 4DMethod?

Skupina4DMethod je skupina uživatelů 4D, kterou organizuje Brent Raymond.

Skupina pořádá pravidelná setkání, jejichž cílem je poskytnout komunitu uživatelům i vývojářům 4D, diskutovat o technických problémech se současnými systémy a nápadech na budoucí vývoj, nabízet řešení kódování pro nové i zkušené vývojáře a mnoho dalšího.

Více informací o 4DMethod najdete zde.