#docascode — Public Fediverse posts

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

Формат DITA позволяет полностью сосредоточиться на содержании документа и не думать о его оформлении. Кроме того, этот инструмент помогает легко и быстро вносить изменения и дополнения в уже написанные ранее документы. Если с DITA как следует разобраться, то потом написание сложных технических документов существенно упростится. В этой статье я расскажу об основных достоинствах DITA.

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

There is vale.sh for writing better docs and linting them. But is there also a good tool to check if the structure is compatible with some kind of a schema? Like containing specific headings and a minimum amount of words as a description. #documentation #DocAsCode

Wollt ihr mehr über #Methoden, #Vorlagen und #Tools erfahren, die zum Erstellen einer hochwertigen, sich selbst validierenden #Softwaredokumentation eingesetzt werden? Dann hört euch den Vortrag von @sippsack und @dirkmahler auf der #bettercode an. Sie zeigen euch u. a. Ansätze wie #Docs-as-Code, leichtgewichtige Textformate, Ablage in der Versionsverwaltung und die Einbettung in die Build- und Review-Prozesse. 👉
https://archdoc.bettercode.eu/veranstaltung-20915-se-0-lebendige-architekturdokumentation-mit-docs-as-code-jqassistant-und-jmolecules.html

#softwarearchitecture #softwaredokumentation #docascode

Parlons documentation avec @themr0c, Senior Technical Writer chez Red Hat !

https://smartlink.ausha.co/projets-libres/fabrice-flore-thebault-senior-technical-writer-chez-red-hat

#podcast #IA #nocode #documentation #kubernetes #OpenSource #ansible #freesoftware #rudder #redhat #docascode #antora #fosdem #glpi #obsidian #NoCodeFrance

0.7.1 release of #py2puml 🎉

Several improvements of the generated #PlantUML syntax:
- use the 'namespace' instructions to group and nested datastructure definitions, to illustrate the codebase structure
- complex compound types (like Dict[Tuple[str], List[SomeClasse]]) are handled

Py2puml is a #DocAsCode tool, which generates a class diagram from your #Python app codebase.

- try it out: https://pypi.org/project/py2puml/
- give some feedback (issues and ⭐ are appreciated 🙏): https://github.com/lucsorel/py2puml

✨ 1st release of #pydoctrace 🎉
Trace #Python code execution with a decorator to view the corresponding sequence diagram in #PlantUML syntax.

#DocTracing generates documentation from real-life code execution and illustrates how the codebase is executed and organized. It helps discussing architecture or teaching algorithms. #DocAsCode

- try it out: https://pypi.org/project/pydoctrace/
- give some feedback (issues and ⭐ are appreciated 🙏): https://github.com/lucsorel/pydoctrace

Version 0.6.1 of #py2puml is released 🎉

This #Python library generates the class diagram of the data structures defined in your codebase. This new version handles class having digits in their names.

#DocAsCode helps documenting the codebase, understanding and maintaining it with better insights.

https://pypi.org/project/py2puml/

RT @[email protected]

starting from 1.2.0.RC2 don't forget to include the @[email protected] feature (amongst others) when you're creating your new @[email protected] project:

mn create-app --features asciidoctor HelloWorld

so you'll have the #gradle/#maven plugin included and one index.adoc to start
#DocAsCode

🐦🔗: https://twitter.com/jagedn/status/1148557115860180992