home.social

#docascode — Public Fediverse posts

Live and recent posts from across the Fediverse tagged #docascode, aggregated by home.social.

  1. Habr @[email protected] ·

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

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

    habr.com/ru/companies/bercut/a

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

    #bercut #техническая_документация #docascode #форматы_документов #xml #пользовательская_документация
  2. Habr @[email protected] ·

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

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

    habr.com/ru/companies/bercut/a

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

    #bercut #техническая_документация #docascode #форматы_документов #xml #пользовательская_документация
  3. Habr @[email protected] ·

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

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

    habr.com/ru/companies/bercut/a

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

    #bercut #техническая_документация #docascode #форматы_документов #xml #пользовательская_документация
  4. Habr @[email protected] ·

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

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

    habr.com/ru/companies/bercut/a

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

    #dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml
  5. Paepke @[email protected] ·

    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

    #documentation #docascode
  6. embarc Software Consulting @[email protected] ·

    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. 👉
    archdoc.bettercode.eu/veransta

    #softwarearchitecture #softwaredokumentation #docascode

    #methoden #vorlagen #tools #softwaredokumentation #bettercode #docs
  7. embarc Software Consulting @[email protected] ·

    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. 👉
    archdoc.bettercode.eu/veransta

    #softwarearchitecture #softwaredokumentation #docascode

    #methoden #vorlagen #tools #softwaredokumentation #bettercode #docs
  8. embarc Software Consulting @[email protected] ·

    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. 👉
    archdoc.bettercode.eu/veransta

    #softwarearchitecture #softwaredokumentation #docascode

    #methoden #vorlagen #tools #softwaredokumentation #bettercode #docs
  9. embarc Software Consulting @[email protected] ·

    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. 👉
    archdoc.bettercode.eu/veransta

    #softwarearchitecture #softwaredokumentation #docascode

    #docascode #softwarearchitecture #docs #bettercode #softwaredokumentation #tools
  10. embarc Software Consulting @[email protected] ·

    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. 👉
    archdoc.bettercode.eu/veransta

    #softwarearchitecture #softwaredokumentation #docascode

    #methoden #vorlagen #tools #softwaredokumentation #bettercode #docs
  11. Podcast Projets libres @[email protected] ·

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

    smartlink.ausha.co/projets-lib

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

    #podcast #ia #nocode #documentation #kubernetes #opensource
  12. Podcast Projets libres @[email protected] ·

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

    podcast.ausha.co/projets-libre

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

    #podcast #ia #nocode #documentation #kubernetes #opensource
  13. Podcast Projets libres @[email protected] ·

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

    podcast.ausha.co/projets-libre

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

    #podcast #ia #nocode #documentation #kubernetes #opensource
  14. Podcast Projets libres @[email protected] ·

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

    podcast.ausha.co/projets-libre

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

    #nocodefrance #obsidian #glpi #fosdem #antora #docascode
  15. Podcast Projets libres @[email protected] ·

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

    podcast.ausha.co/projets-libre

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

    #podcast #ia #nocode #documentation #kubernetes #opensource
  16. Luc Sorel-Giffo @[email protected] ·

    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: pypi.org/project/py2puml/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/py2puml

    #python #docascode #plantuml #py2puml
  17. Luc Sorel-Giffo @[email protected] ·

    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: pypi.org/project/py2puml/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/py2puml

    #python #docascode #plantuml #py2puml
  18. Luc Sorel-Giffo @[email protected] ·

    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: pypi.org/project/py2puml/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/py2puml

    #python #docascode #plantuml #py2puml
  19. Luc Sorel-Giffo @[email protected] ·

    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: pypi.org/project/py2puml/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/py2puml

    #py2puml #plantuml #docascode #python
  20. Luc Sorel-Giffo @[email protected] ·

    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: pypi.org/project/py2puml/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/py2puml

    #python #docascode #plantuml #py2puml
  21. Luc Sorel-Giffo @[email protected] ·

    ✨ 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: pypi.org/project/pydoctrace/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/pydoctrace

    #docascode #doctracing #plantuml #python #pydoctrace
  22. Luc Sorel-Giffo @[email protected] ·

    ✨ 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: pypi.org/project/pydoctrace/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/pydoctrace

    #docascode #doctracing #plantuml #python #pydoctrace
  23. Luc Sorel-Giffo @[email protected] ·

    ✨ 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: pypi.org/project/pydoctrace/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/pydoctrace

    #docascode #doctracing #plantuml #python #pydoctrace
  24. Luc Sorel-Giffo @[email protected] ·

    ✨ 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: pypi.org/project/pydoctrace/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/pydoctrace

    #pydoctrace #python #plantuml #doctracing #docascode
  25. Luc Sorel-Giffo @[email protected] ·

    ✨ 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: pypi.org/project/pydoctrace/
    - give some feedback (issues and ⭐ are appreciated 🙏): github.com/lucsorel/pydoctrace

    #docascode #doctracing #plantuml #python #pydoctrace
  26. Luc Sorel-Giffo @[email protected] ·

    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.

    pypi.org/project/py2puml/

    #docascode #python #py2puml
  27. Luc Sorel-Giffo @[email protected] ·

    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.

    pypi.org/project/py2puml/

    #docascode #python #py2puml
  28. Luc Sorel-Giffo @[email protected] ·

    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.

    pypi.org/project/py2puml/

    #docascode #python #py2puml
  29. Luc Sorel-Giffo @[email protected] ·

    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.

    pypi.org/project/py2puml/

    #py2puml #python #docascode
  30. Luc Sorel-Giffo @[email protected] ·

    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.

    pypi.org/project/py2puml/

    #docascode #python #py2puml
  31. Markus Schlichting @[email protected] ·

    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

    🐦🔗: twitter.com/jagedn/status/1148

    #docascode #gradle