takaways.adoc

Takeways

Documentation is about Knowledge

That is worth sharing

Core Principles of Living Documentation

• Reliable

• Low effort

• Collaborative

• Insightful

• Fiable

• Nécessite peu d’effort

• Collaborative

• Révélatrice

Learn…​

• Your languages

• Your tools and what they can produce

• Generic knowledge

Remember

• Favor conversations and working together

• Knowledge is mostly already there

You can begin with…​

Reviewing the quality of your current documentation

• Where is it? Multiple places? Duplicated?

• Is it up to date?

• How many authors of the last updates have left the team?

• Does documentation explains WHY or just HOW?

• Can you trust the diagrams?

• Is some knowledge redundant between the source and