Настанови з написання підручника¶

Мета¶

Акцент на користувачі: Підручник має лишатися зрозумілим для початківців у редагуванні відео.
Повнота: Має бути описано усі можливості, параметри та інструменти Kdenlive. У підручнику мають бути відомості щодо самої можливості, її призначення і способу користування нею.
Стислість: Текст має бути коротким, інформативним та пов’язаним із темою, про яку ви оповідаєте.
Придатність до супроводу: Пишіть так, щоб текст не треба було повністю переписувати, коли до Kdenlive буде внесено незначні зміни.

Настанови¶

Вміст¶

Використовуйте американську англійську (приклад: modeling, а не modelling, color, а не colour), а також форматування чисел (приклад: 2,718.28, а не 2 718,28).
Користуйтеся засобами перевірки правопису
Зважайте на граматику, використання відповідних слів та простоту використаної англійської.
Зважайте на те, що може бути цікавим для тих, хто редагує відео.
Описуйте речі у загальному плані, не заглиблюючись аж надто, щоб не було потреби у коригуванні документації для кожної нової версії Kdenlive.
Не описуйте вади у поточному стані програми.
Включіть відомості щодо того, чому і як певна можливість може бути корисною. Приклад: Переваги використання послідовності.
Якщо ви не певні щодо того, як працює можливість, спитайте когось або знайдіть розробників властивості і спитайте у них.
ви можете додати коментар (який не буде показано на сторінці HTML page, але який є корисним для інших редакторів): .. ЗАВДАННЯ: як вибрати правильний формат виведення та бітову швидкість? Запитати у досвідченого користувача.

Стиль¶

Використовуйте короткі і зрозумілі речення, користуйтеся дієсловами і менше використовуйте іменники. Створені у такий спосіб текст просто читати, вони є предметними і цілеспрямованими. Типове правило (але не лише!): 20 слів або 120 літер на речення.
Будьте конкретними: не пишіть пристрій введення, коли маєте на увазі миша.
Не стійте на місці: кожне речення має описувати щось нове.
Користуйтеся напівжирним шрифтом для виокремлення: Назви програм
Користуйтеся курсивом для акцентування: Слова або речення у загальному тексті, Назви при посиланні на інші роботи, Перший випадок використання незвичного слова
Поєднання напівжирного та курсиву: у тексті rst це можна зробити лише за допомогою додаткового коду.

Надання спочатку визначення

Sequence
Using sequences you can make your project clearer.

краще

Sequence
A sequence is basically a timeline.

Ніж пояснення призначення, а потім пояснення щодо користування. Приклад: Послідовність

Уникайте негайного повторення терміна

The Properties Tab
The Properties Tab displays the settings for the effects on the currently selected clip.

краще

The Properties Tab
The settings for the effects on the currently selected clip are shown the properties tab.

уникайте «it is»

Binarize
It is an effect to make he image black and white.

краще

Binarize
Creates a black and white image.

Зображення¶

Для розміщення зображень слід використовувати лише .. figure::.

При створенні знімків вікон користуйтеся темною темою Kdenlive.

Використовуйте для зображень .webp.

Користуйтеся анімованими файлами .gif або .mp4, якщо це краще пояснює можливість або завдання.

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

Подальша інформація¶

Ознайомтеся із шаблоном, щоб дізнатися більше про використання команд rst.