Списки задач
Списки задач являются расширением GitHub Flavored Markdown, используемым для создания интерактивных списков дел, широко применяемых в управлении проектами и отслеживании задач.
Базовый синтаксис списков задач
Незавершенные задачи
Используйте - [ ]
для создания элементов незавершенных задач:
markdown
- [ ] Завершить документацию проекта
- [ ] Написать модульные тесты
- [ ] Развернуть в производственной среде
Результат:
- [ ] Завершить документацию проекта
- [ ] Написать модульные тесты
- [ ] Развернуть в производственной среде
Завершенные задачи
Используйте - [x]
или - [X]
для создания элементов завершенных задач:
markdown
- [x] Настроить структуру проекта
- [X] Разработать структуру базы данных
- [x] Внедрить аутентификацию пользователей
Результат:
- [x] Настроить структуру проекта
- [X] Разработать структуру базы данных
- [x] Внедрить аутентификацию пользователей
Смешанные списки задач
markdown
## Прогресс разработки проекта
- [x] Анализ требований
- [x] Выбор технологий
- [ ] Разработка frontend
- [x] Страница входа
- [x] Главная страница
- [ ] Страница профиля пользователя
- [ ] Разработка backend
- [x] API управления пользователями
- [ ] API управления заказами
- [ ] Интерфейс оплаты
- [ ] Тестирование
- [ ] Модульные тесты
- [ ] Интеграционные тесты
- [ ] Развертывание и запуск
Результат:
Прогресс разработки проекта
- [x] Анализ требований
- [x] Выбор технологий
- [ ] Разработка frontend
- [x] Страница входа
- [x] Главная страница
- [ ] Страница профиля пользователя
- [ ] Разработка backend
- [x] API управления пользователями
- [ ] API управления заказами
- [ ] Интерфейс оплаты
- [ ] Тестирование
- [ ] Модульные тесты
- [ ] Интеграционные тесты
- [ ] Развертывание и запуск
Правила форматирования списков задач
Требования к синтаксису
Элемент | Синтаксис | Описание |
---|---|---|
Маркер списка | - | Должен использоваться дефис |
Пробел |
| Должен быть пробел после дефиса |
Флажок | [ ] | Пробел внутри скобок указывает на незавершенность |
Завершено | [x] или [X] | 'x' внутри скобок указывает на завершение |
Текст | Любой текст | Должен быть пробел после флажка |
Примеры правильного формата
markdown
✅ Правильный формат:
- [ ] Задача 1
- [x] Задача 2
- [X] Задача 3
❌ Неправильный формат:
-[ ] Отсутствует пробел
-[] Отсутствует содержимое флажка
- [o] Неправильный маркер
* [ ] Неправильный символ списка
Вложенные списки задач
Многоуровневая структура задач
markdown
- [ ] 📋 Планирование продукта
- [x] Маркетинговое исследование
- [x] Анализ конкурентов
- [ ] Интервью с пользователями
- [x] Подготовка вопросов для интервью
- [ ] Связаться с целевыми пользователями
- [ ] Проведение интервью
- [ ] Систематизация результатов интервью
- [ ] Написание документа с требованиями
- [ ] 🎨 UI/UX дизайн
- [ ] Разработка прототипа
- [x] Прототип низкой детализации
- [ ] Прототип высокой детализации
- [ ] Визуальный дизайн
- [ ] Цветовая схема
- [ ] Дизайн иконок
- [ ] Дизайн страниц
- [ ] 💻 Техническая разработка
- [x] Проектирование технической архитектуры
- [ ] Разработка frontend
- [ ] Разработка backend
- [ ] Проектирование базы данных
Результат:
[ ] 📋 Планирование продукта
- [x] Маркетинговое исследование
- [x] Анализ конкурентов
- [ ] Интервью с пользователями
- [x] Подготовка вопросов для интервью
- [ ] Связаться с целевыми пользователями
- [ ] Проведение интервью
- [ ] Систематизация результатов интервью
- [ ] Написание документа с требованиями
[ ] 🎨 UI/UX дизайн
- [ ] Разработка прототипа
- [x] Прототип низкой детализации
- [ ] Прототип высокой детализации
- [ ] Визуальный дизайн
- [ ] Цветовая схема
- [ ] Дизайн иконок
- [ ] Дизайн страниц
- [ ] Разработка прототипа
[ ] 💻 Техническая разработка
- [x] Проектирование технической архитектуры
- [ ] Разработка frontend
- [ ] Разработка backend
- [ ] Проектирование базы данных
Улучшения списков задач
Использование эмодзи для категоризации
markdown
## 📅 План задач на неделю
### 🔥 Высокий приоритет
- [x] 🐛 Исправить ошибку на странице входа
- [ ] 🚀 Выпустить версию v2.1
- [ ] 📊 Завершить квартальный отчет
### 📋 Обычные задачи
- [x] 📝 Обновить документацию
- [ ] 🧪 Написать тестовые случаи
- [ ] 🔍 Провести код-ревью
### 💡 Предложения по улучшению
- [ ] ⚡ Оптимизировать скорость загрузки страницы
- [ ] 🎨 Улучшить пользовательский интерфейс
- [ ] 📱 Адаптация для мобильных устройств
Результат:
📅 План задач на неделю
🔥 Высокий приоритет
- [x] 🐛 Исправить ошибку на странице входа
- [ ] 🚀 Выпустить версию v2.1
- [ ] 📊 Завершить квартальный отчет
📋 Обычные задачи
- [x] 📝 Обновить документацию
- [ ] 🧪 Написать тестовые случаи
- [ ] 🔍 Провести код-ревью
💡 Предложения по улучшению
- [ ] ⚡ Оптимизировать скорость загрузки страницы
- [ ] 🎨 Улучшить пользовательский интерфейс
- [ ] 📱 Адаптация для мобильных устройств
Добавление подробной информации
markdown
- [ ] **Функция регистрации пользователей** `Важно`
- Внедрить регистрацию по электронной почте
- Добавить проверку номера телефона
- Интеграция входа через третьи стороны (WeChat, QQ)
- **Крайний срок**: 2023-12-15
- **Ответственный**: Чжан Сань
- [x] **Интеграция платежной системы** `Завершено`
- Интерфейс Alipay
- Интерфейс WeChat Pay
- Оплата банковской картой
- **Дата завершения**: 2023-11-20
- **Ответственный**: Ли Сы
- [ ] **Оптимизация базы данных** `В процессе`
- Оптимизация производительности запросов
- Перестроение индексов
- Очистка данных
- **Ожидаемая дата завершения**: 2023-12-10
- **Ответственный**: Ван У
Результат:
[ ] Функция регистрации пользователей
Важно
- Внедрить регистрацию по электронной почте
- Добавить проверку номера телефона
- Интеграция входа через третьи стороны (WeChat, QQ)
- Крайний срок: 2023-12-15
- Ответственный: Чжан Сань
[x] Интеграция платежной системы
Завершено
- Интерфейс Alipay
- Интерфейс WeChat Pay
- Оплата банковской картой
- Дата завершения: 2023-11-20
- Ответственный: Ли Сы
[ ] Оптимизация базы данных
В процессе
- Оптимизация производительности запросов
- Перестроение индексов
- Очистка данных
- Ожидаемая дата завершения: 2023-12-10
- Ответственный: Ван У