Огляд

На цій сторінці визначено посібник зі стилю для dtdocs та інформацію про те, як зробити свій внесок у проект.

Він включений в посібник користувача, щоб ви могли бачити, як відображається сторінка, а також як вона пишеться. Перейдіть на GitHub, щоб побачити джерело для цієї сторінки.

Структура та зміст посібника були ретельно обмірковані на основі таких критеріїв:

  1. Посібник повинен бути вичерпним – він повинен описувати всю функціональність, доступну в Darktable
  2. Він повинен мати узгоджену та логічну структуру, і кожен елемент функціональності повинен мати своє логічне місце в цій структурі
  3. Він повинен бути настільки довгим, наскільки це потрібно, але настільки коротким, наскільки це можливо – стислість обов’язкова
  4. Він повинен бути об’єктивним
  5. Функціональність слід пояснити один раз і лише один раз (за винятком вказівок щодо базового робочого процесу в розділі огляду)
  6. Зображення слід включати лише там, де це необхідно для поліпшення розуміння ключових принципів, і вони не повинні містити текст, хіба що цього не уникнути

Нас, як правило, не цікавить:

  1. Реструктуризація посібника
  2. Зміна мови розмітки
  3. Детальні підручники з робочого процесу (хоча ми зацікавлені в їх публікації у блогах darktable.org або pixls.us)

Нас цікавить

  1. Виправлення правопису та граматики
  2. Уточнення тексту
  3. Документація щодо нових функцій

Нам завжди надзвичайно цікаво почути, які розділи посібника для вас не мали сенсу та чому, щоб ми могли вдосконалити документацію.

Загалом, якщо ви хочете внести серйозні зміни, будь ласка, відкрийте issue на GitHub та обговоріть її спочатку з мейнтейнерами. Це для того, щоб уникнути виконання роботи, яка не була б прийнята.

🔗modality

Бажаний спосіб – створити пул-реквест. Див. робочий процес для отримання детального покрокового керівництва.

Якщо ви не знаєте, що це таке, або вам незручно це робити, не соромтеся запропонувати незначні покращення документації, піднявшинову проблему (issue) на GitHub.

translations