Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 4.87 KB

tech-enquiry.md

File metadata and controls

66 lines (49 loc) · 4.87 KB
Raw

Требования к ТЗ для техписателя

⚠️ Без внятного ТЗ результат ХЗ. (Автор умной мысли неизвестен).

План ТЗ

Чтобы техпис порадовал вас хорошим результатом, ориентируйтесь на вопросы известной игры:

1. Что?

Внятно сформулируйте задачу. Своими словами, но в деталях и понятным языком. При необходимости распишите на подпункты.

Плохо Хорошо
Там обновления выкатили, опиши красиво. Составьте подробную инструкцию "Как сотворить чудо по методике Хогвардса".
- Опишите, из чего и как сделать волшебную палочку.
- Распишите по шагам, как правильно произносить двухэтапные заклинания.
- Перечислите все возможные способы, как лучше всего избавиться от дохлых морских свинок.

2. Где?

Здесь напишите:

  • где объект, который нужно описать (ССЫЛКА, путь в интерфейсе ПО и т.д.);
  • где можно ознакомиться с теорией по вопросу, если что-то есть (исходники, ССЫЛКИ);
  • к кому обращаться за консультацией и кто проверит результат (ССЫЛКИ на контакты);
  • где разместить итоговую статью (ССЫЛКА на раздел с пояснением, если нужно).

Дополнительно можете прописать важную информацию, какие-то специфические термины, на что обратить особое внимание. ВСЕГДА прикладывайте ССЫЛКИ: где найти исходные материалы (если есть) и где разместить итоговый материал.

3. Когда?

Здесь укажите крайний или желательный (при этом адекватный) срок готовности документа.
Можете указать приоритет задачи (в произвольной форме).

Пример ТЗ

(Ссылки в задании пустые для примера)

1. Что сделать

Внести раздел 2.2 Транзакции с токенами в инструкцию Работа с персональным кошельком.

Примерное содержание, которое хотелось бы видеть:

  • Вводная часть (не более абзаца) о назначении раздела.
  • Как провести исходящую транзакцию. Пошаговая инструкция.
  • Как просмотреть историю исходящих транзакций, какие данные можно увидеть (можно оформить таблицей).

2. Где брать информацию

  • Ссылка на интерфейс: www.UI-example.com/transfer
  • Проверить можно в любом браузере.
  • Доступ в тестовую админку: логин LOGIN, пароль QWERTY
  • Для корректной работы установите Plugin.
  • Кое-что можно прочитать здесь и здесь.
  • Можно напрямую консультироваться с разработчиком Васей Васиным.

3. Когда сдать работу

Дэдлайн 32.02.2022
Приветствуется периодическое предоставление чернового варианта.