https://github.com/LivingDocumentation/awesome-living-documentation

A curated list of stuff about Awesome Living Documentation
https://github.com/LivingDocumentation/awesome-living-documentation

List: awesome-living-documentation

Last synced: 2 months ago
JSON representation

A curated list of stuff about Awesome Living Documentation

• Host: GitHub
• URL: https://github.com/LivingDocumentation/awesome-living-documentation
• Owner: LivingDocumentation
• License: other
• Created: 2016-09-28T13:25:53.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-07-30T07:54:51.000Z (over 2 years ago)
• Last Synced: 2024-05-20T19:39:11.354Z (9 months ago)
• Size: 28.3 KB
• Stars: 98
• Watchers: 12
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.adoc
  • License: LICENSE.adoc

Awesome Lists containing this project

• awesome-starred - LivingDocumentation/awesome-living-documentation - A curated list of stuff about Awesome Living Documentation (others)

README

        

= awesome-living-documentation

:toc:

:toc-placement!:

A curated list of stuff about Awesome Living Documentation

toc::[]

== Books

* https://leanpub.com/livingdocumentation[Living Documentation by design, with Domain-Driven Design] - by Cyrille Martraire(@cyriux).

== Video

* https://www.youtube.com/watch?v=Tw-wcps7WqU[Living Documentation : vous allez aimer la documentation !] - by Cyrille Martraire, Devoxx France 2016.

* https://www.youtube.com/watch?v=xbcFyYIKZ_M&list=PLUJzERpatfsXGv1q1kolSgriwVZXRqKVw&index=25[La boite à outils pour une Living Documentation] - by Benoit Prioux, BDX/IO 2016.

* https://www.youtube.com/watch?v=LG4SADs2nf8[[SC] Living Documentation] - by Sébastien Fauvel, BreizhCamp 2020.

* https://www.youtube.com/watch?v=v--zkIEciq4&t=1378s[Architecture Hexagonale Level 2: Comment bien écrire vos tests (22m58s - 27m30s)] - Spring Rest Docs AsciiDoc - HTTP snippets generated from tests - by Julien Topçu & Jordan Nourry, BDX I/O 2019.

** https://gitlab.com/crafts-records/talkadvisor/talkadvisor-back[TalkAdvisor BackEnd code repo from the talk]

== Blog

* https://rmannibucau.metawerx.net/post/generate-configuration-from-code-adoc[Generate your adoc module/application configuration instead of maintaining it manually] - by Romain Manni-Bucau.

== Behaviour Driven Development

* https://cucumber.io/[cucumber] - A framework to integrate BDD in your project with multiple language implementation.

* http://rmpestano.github.io/cukedoctor/[cukedoctor] - A cucumber plugin for better reporting.

== Language

* http://asciidoctor.org/[asciidoctor] - A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.

** https://zenika.github.io/adoc-presentation-model/reveal/syntax-quick-reference.html[AsciiDoc Syntax Quick Reference]

** https://zenika.github.io/adoc-presentation-model/reveal/reveal-my-asciidoc.html[Reveal my Asciidoc - a deep dive into presentation as code]

* https://github.com/cucumber/cucumber/wiki/Gherkin[gherkin] - Business Readable, Domain Specific Language used by cucumber.

* https://hexdocs.pm/ex_unit/ExUnit.DocTest.html[Elixir ExUnit.DocTest] - Allows to generate executable tests from examples in code documentation.

* https://doc.rust-lang.org/rustdoc/documentation-tests.html[Rust Documentation Tests] - Allows running your documentation examples as tests. 

== Tools

* https://github.com/Arnauld/tzatziki - Cucumber documentation generation tools.

* https://www.picklesdoc.com/ - An open source living documentation generator.

* https://github.com/cyriux/dot-diagram[dot-diagram] - A java library to generate dot diagram.

* https://chrome.google.com/webstore/detail/plantuml-viewer/legbfeljfbjgfifnkmpoajgpgejojooj[plantuml-viewer] - Chrome plugin to visualize image representation of plantuml syntax.

* https://github.com/paul-hammant/qdox[qdox] - A java library to parse code, useful to generate code based documentation.

* https://github.com/ferstl/depgraph-maven-plugin[depgraph] - A maven plugin to generate dependencies graph.

* https://gist.github.com/javathought/b9ad1e34047ad99a96fed6fce0016e68 - A Notepad++ syntax highlighting for Gherkin with en,fr keywords.

== Templates

* https://github.com/bflorat/modele-da - An AsciiDoc starting point for technical achitecture document artifact (French)