Перейти до змісту

Вступ

Чому цей розділ?

Наприкінці 2024 року стало очевидно, що не кожен документ кешу документації Rocky Linux буде інструкцією. Нам потрібне було місце для довших, більш глибоких пояснень. Увійдіть у цей блог.

Хто тут може писати?

Кожен, хто має облікові дані GitHub, може надіслати запропоновану статтю тут. Щоб розпочати, перегляньте документи в розділі Внеси.

Примітка

Якщо у вас немає облікових даних GitHub, але ви все одно хочете написати щось для цього розділу, зв’яжіться з нами за посиланням на канал Mattermost унизу цієї сторінки.

Ви повинні переконатися, що ваш документ відповідає вимогам цього розділу. Наприклад:

  • Це підходить сюди? Чи варто ділитися цією інформацією? Це документ у стилі блогу?
  • Чи розкриває він тему, важливу для документалістів?
  • Чи підвищить подання загальну якість документації Rocky Linux?

Яка інформація?

Перші два документи тут повинні дати вам уявлення про те, що підходить. Протягом 2024 року ми докладали спільних зусиль, щоб усунути або суттєво скоротити пасивний стан у документах з інструкціями. У документі [Active voice: шлях до простого, ясного спілкування] (active_voice.md) описується важливість активного голосу в тональності документації, легкість читання та розуміння, а також спрощення перекладу іншими мовами. У документі [Open source: Чому це ніколи не ставиться через дефіс] (open_source.md) обговорюється велика дискусія навколо цього питання та аргументація нашого рішення не ставити через перенос. Зрозуміла ідея? Ці інформаційні документи не містять інструкцій, за винятком, можливо, прикладів.

Зростання цього блогу?

Цей набір документів, імовірно, зростатиме повільніше, ніж документи з інструкціями. Це нормально. Якість і відповідність документів тут найважливіше.

Зворотній зв'язок

Як і щодо проекту документації в цілому, ви можете залишити відгук на нашому Documentation Mattermost channel.

Author: Steven Spencer