# Создание эффективной документации для Discourse

**URL:** https://meta.discourse.org/t/writing-effective-documentation-for-discourse/309628
**Category:** Contributing
**Tags:** reference
**Created:** [28.Май.2024 04:24:22 UTC](https://meta.discourse.org/t/writing-effective-documentation-for-discourse/309628 "2024-05-28T04:24:22Z")
**Posts on this page:** 1
**Showing post:** 14

<div class="post-metadata">

### Author: ![ondrej](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/ondrej/32/198804_2.png) [@ondrej](https://meta.discourse.org/u/ondrej)
#### Post date: [19.Июнь.2024 15:47:49 UTC](https://meta.discourse.org/t/writing-effective-documentation-for-discourse/309628/14 "2024-06-19T15:47:49Z")

</div>

Что касается части [метаблока](https://meta.discourse.org/t/documentation-style-guide/309628#meta-block-2) в руководстве. Хотя, согласно приведённому выше руководству, темам документации необходим метаблок, не все темы его содержат \[1\], и их оформление не всегда единообразно. Вот несколько примеров из найденных мной руководств:

> [@Discourse](#):
>
> 🙋 Требуемый уровень доступа: Любой

> [@Discourse](#):
>
> 🙋 Требуемый уровень доступа: Все пользователи

> [@Discourse](#):
>
> 🙋 Требуемый уровень доступа: Любой пользователь

Лично мне нравится вариант «Все пользователи».

Я не хотел вносить изменения в темы, не собрав предварительно обратную связь 😃

* * *

1. возможно, это зависит от контекста темы

---

_[View the full topic](https://meta.discourse.org/t/writing-effective-documentation-for-discourse/309628)._