Документація

Документація буває багатьох видів, але тут буде розглянена саме документація користувача, яку пише тестувальник. А саме будуть відображені головні правила ведення документації та надані корисні посилання, оскільки зміст документації може постійно відрізнятися і мати різну деталізацію і наповнення.

Структура документації

Документація має містити, приблизно, таку структуру:

project_name
│
└─ docs
    ├─ docs - тут містяться файли які і є документацією
    │
    └─ mkdocs.yml - файл формату .yml, який "відповідає" за генерацію
                    і налаштування документації

У випадку багатомовної версії інструкції, структура буде мати наступний вигляд:

project_name
│
└─ docs
   ├─ config/
   │    ├─ uk/
   │    │   └─ mkdocs.yml - файл для генерації україномовної версії документації
   │    └─ en/
   │        └─ mkdocs.yml - файл для генерації англомовної версії документації
   │
   └─ docs
        ├─ uk - всередині міститься україномовна документація
        │   
        └─ en - всередині міститься англомовна документація 

Наповнення папки docs

Зміст даної папки може бути будь-яким, проте є загальні правила для написання інструкції.

💡 "Базові правила наповнення папки docs"

Перш за все, у папці необхідно створити "головний" файл. Даний файл має назву index.md. Він несе в собі функцію заголовної сторінки документації

При відкритті документації, наприклад цієї, першою сторінкою відкриється саме index (хоч цього і не буде відображено у посиланні)

ВАЖЛИВО: даний файл є ОБОВ'ЯЗКОВИМ, оскільки без нього документація, просто не згенерується

mkdocs.yml

Приклад конфігу, який використовувався при написанні ції документації, виглядає так:

site_name: Quality Assurance Softpro
theme:
  font:
    text: Noto Serif
  language: uk
  name: material

  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Light

    - scheme: slate
      primary: blue
      toggle:
        icon: material/brightness-3
        name: Dark

  features:
    - content.tabs.link
    - content.tooltips
    - navigation.path
    - navigation.indexes
  feature:
    tabs: true
  logo: img/logo/logo-softpro.png
  favicon: img/logo/favicon-white.png
plugins:
  - search:
      lang: ["ru", "en"]
markdown_extensions:
  - abbr
  - attr_list
  - admonition
  - def_list
  - footnotes
  - md_in_html
  - tables
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
extra:
  generator: false

Корисні посилання

Якщо документацію необхідно відформатувати, додати анотації, кнопки, посилання, зображення і т.д., все це можна знайти у цій статті. Також тут є уся інформація про налаштування конфігу зазначеного вище.

Mkdocs Material :material-note-text:{ .md-button .md-button--primary }