The document discusses technical documentation in software development. It outlines different types of documentation including product documentation, system documentation, user documentation, and process documentation. It also describes common documentation artifacts like requirement documents, architecture documents, roadmaps, source code comments, and quality assurance plans. Finally, it recommends tools for documentation like Jira, Markdown editors, and tools specifically for UX, API, and roadmap documentation.

1. Technical Documentation in
Software Development

2. Hello world!
● Edi Santoso
● Sr. Front-End Engineer
● linkedin.com/in/edi-santoso/

3. ● Kata.ai is a conversational artificial intelligence company.
● The focus of our AI is understanding human conversations, so we can
improve the way humans collaborate with technology. We believe AI can be used
to make all of us more productive and empowered.
● Our NLP technology and Platform has powered chatbots for major companies in
Indonesia, and we’re currently exploring more applications of AI beyond
chatbots.

5. Technical Documentation in Software Development:
Types, Best practices & Tools

6. Project documentation stages

7. Agile and waterfall approaches

8. Agile development cycle scheme

9. Software documentation types

10. Types of documentation
● Product Documentation
● Process Documentation

11. Product documentation
● System Documentation
● User Documentation

12. System documentation

13. Product Requirement Document
● Roles and responsibilities
● Team goals and business objective
● Background and strategic fit
● Assumptions
● User stories
● Acceptance criteria
● User interaction and design
● Questions
● Not doing

14. Software Architecture Document
● Architecture and design principle
● User story description
● Solution details
● Diagrammatic representation of the solution

15. Agile Product roadmap Document
● Strategic roadmap
● Technology roadmap
● Release plan

16. Source code Document
● Coding style guide
● DLS/ Design Language System
● Types of data binding
● Design pattern
● Security measures

17. User Experience Design
Documentation
● User personas
● User scenario
● Scenario map
● User story map
● UX style guide

18. Quality assurance documentation
● Quality management plan
● Test strategy
● Test plan
● Test case specifications
● Test checklists

19. Maintenance and help guide
● API documentation
● FAQs

20. User Documentation
● FAQs
● Video Tutorial
● Release note
● Support portals

21. Process Documentation
● Plans
● Estimates
● Schedules
● Report and metrics
● Working papers
● Standards

22. Tools

23. General purpose tools
● Jira
● Github
● Google Docs

24. Markdown editors
● VS code
● Quip

25. Roadmap tools
● Product plan
● Aha!
● Google sheets

26. Tools for UX documentation
● Sketch
● Figma
● InVision
● Balsamiq
● Zeplin
● Realtime board

27. Tools for API documentation
● Swagger
● Apiary
● Postman
● Insomnia

28. Thank You