---
# System prepended metadata

title: Untitled

---

#documentation #документация

main resources: 
- https://www.altexsoft.com/blog/business/technical-documentation-in-software-development-types-best-practices-and-tools/
- https://increment.com/documentation/why-investing-in-internal-docs-is-worth-it/
- https://www.devteam.space/blog/software-documentation-6-best-practices-that-work/
- https://www.atlassian.com/work-management/documentation
- https://zapier.com/engineering/great-documentation-examples/

_Для чего инвестировать во внутреннюю документацию?_
- Documentation helps orient newcomers.
- Documentation helps create inclusive communities.
- в нашей ситуации еще плюс помогать людям ориентироваться в другом стеке

Единая точка входа и единый инструмент
+ Getting Started (в виде дашборда, лендинга ) 
+ FAQ
+ графические и визуальные вставки 

**ВАЖНО: должно быть удобно искать**

Еще к процессу документации
- Create a standard template
- Schedule time to clean up

**Интерактивная документация**: энпоинты которые можно выполнять (swagger, ...)

**A Developer Blog** - ведут свой дев блог (zapier, yandex, ...)


All software documentation can be divided into **two main categories:**
* **Product documentation**
* **Process documentation**

- **Questions.** As the team solves the problems along the project progression, they inevitably have many questions arising. A good practice is to record all these questions and track them.
- **Not doing.** List the things which you aren’t doing now but plan on doing soon. Such a list will help you organize your teamwork and prioritize features.

* Use **links and anchors**. They will help you make the document easier to read and search as readers will be able to comprehend the information gradually. For instance, you can provide links to customer interviews and anchors to previous discussions or other external information related to the project.
* Use**graphics and** **diagramming tools** to better communicate the problems to your team. People are more likely to perceive information by looking at the images than reading an extensive document. Different visual models will help you to perform this task and outline requirements more effectively. You can incorporate diagrams into your requirements process using the following software diagramming tools: Visio, Gliffy, Balsamiq, Axure or SmartArt in Microsoft Office.



??? 
запросы на обновление документации
запросы на написание документации
