![](https://github.com/CakesTwix.png)
Посібник зі стилю
Посібник зі стилю на допомогу авторам контенту для веб-сайтів. Щодо коду, який використовується для певних сегментів, будь ласка, перегляньте код для цієї сторінки. Зауважте, що я не маю досвіду у створенні таких сторінок, і тому вона була створена за власним бажанням, якщо ви знаєте, як покращити цю сторінку, будь ласка, надішліть її правку або створіть окрему тему.
FAQ
Деякі РОБИТИ і НЕ РОБИТИ для FAQ.
НЕ бійтеся звертатися за допомогою, зокрема, щоб пояснити, що означають деякі частини цієї сторінки.
ТРЕБА записувати кожен сегмент у вигляді запитання:
Як я можу побачити, скільки розділів я завантажив?
ТРЕБА писати інструкції якомога зрозуміліше, бажано спочатку порадитися з іншими людьми і дізнатися, чи можуть вони допомогти вам покращити формулювання.
НЕ пишіть дуже неохайно, це ускладнює розуміння як нам, так і користувачеві.
НЕ забувайте перевіряти принаймні базові граматичні помилки, зокрема, відсутність великої літери в першому слові та забування ком/крапок у першому слові.
ПЕРЕВАЖНО, у зв'язку з вищезазначеним, використовуйте ресурси, які можуть допомогти з граматикою та загальною структурою:
- [Grammarly] (https://app.grammarly.com/) - застосунок для письма від Grammarly гарантує, що все, що ви друкуєте, буде не лише правильним, але й зрозумілим і легким для читання.
- Hemmingway App - Hemingway App зробить ваше текст більш зрозумілим і легким для сприйняття.
Бажано спробувати створити середовище і протестувати його спочатку на локальному ПК/сервері, перш ніж надсилати свій PR, попросіть про допомогу, якщо вона вам потрібна.
Використовуйте контейнери, щоб швидко показати, що ви зробили
Інструкції
Увімкніть його, перейшовши за посиланням → →Дисплей, а потім виберіть опцію Завантажити бейджі внизу.
- Намагайтеся бути послідовними під час відеозапису, дотримуючись цих вказівок:
Рекомендації щодо запису відео
При створенні відео бажано використовувати емулятор від Android Studio для отримання постійного результату щоразу. Налаштування емулятора > для зображень на першій сторінці - Pixel 3 XL під управлінням Android 10.
- Записуйте відео у форматі MP4 або WEBM, залежно від того, що вам зручніше. Використовуйте вбудований в Android Демонстраційний режим, його можна знайти в налаштуваннях розробника.
- Записуйте в чистому робочому просторі і не поспішайте і не кваптеся з діями.
- Використовуйте символи стрілок в інструкціях замість символів "більше":
Початок → Мета
- Виділіть важливі слова в тексті жирним шрифтом:
...поставивши галочку біля опції Завантажити бейджики...
- ТРЕБА використовувати Шорткоди елементи, де це можливо:
- Не використовуйте невпорядковані списки, коли пишете список речей, які не є інструкціями:
- Ця річ.
- І ця річ.
НЕ використовуйте невпорядковані списки для інструкцій.
Якщо ви пишете довгу інструкцію, використовуйте впорядковані списки:
- Крок перший.
- Крок другий.
- Використовуйте вкладки з інструкціями, коли це необхідно для ефективної роботи:
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
- Обов'язково додавайте пов'язану інформацію як окремий об'єкт:
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Примітка
Відповідна проблема на GitHub: #1
- ТРЕБА використовувати кодові теги для кодів помилок та назв файлів:
Помилка, пов'язана з масивом:
Exception in thread "main" java.lang.ArrayIndexOutOfBoundsException...