Как разработчик программного обеспечения, работающий над разными типами проектов, я часто забываю, что делал раньше. Я даже иногда забываю задачи, над которыми работал раньше в том же проекте. Здесь поможет запись важной информации.
Наличие документа, пусть даже грубо набросанного, значительно упрощает работу, когда мне позже нужно что-то сообщить или представить другим коллегам. Мне не нужно пытаться вспомнить конкретные детали, просматривать коммиты или снова читать коды.
Итак, в этом посте я делюсь своими лучшими советами о том, как я обычно пишу технические документы.
Раздельное написание и редактирование
Если вы попытаетесь сделать и то, и другое, задача покажется слишком сложной. Писательство – это больше творческая деятельность. Редактировать более логично. Эти типы деятельности происходят по-разному в мозгу. Смешивая и то, и другое, вы будете тратить больше времени, делая вещи менее творческими и сложными для вас.
Ваш первый набросок должен содержать только все, что вы можете придумать, независимо от порядка, структуры и стиля. Не думайте, когда пишете (не думайте больше, чем следует). Просто стремитесь поделиться тем, что было сделано, и поместите это на экран. Процесс редактирования займет много времени с несколькими итерациями.
Еще один хороший совет — пишите так, как будто вы кому-то что-то объясняете. Затем, когда вы редактируете — уточняете, вырезаете что-то — чтобы сделать его более кратким. Обычно я редактирую свои документы в течение нескольких дней, когда мой мозг более свежий.
Дополнительный бонус: не используйте инструменты редактирования, такие как Grammarly, при написании первого черновика.
Сообщите о своей работе
Я бы сказал, что документирование вашей работы и выполнение фактической работы одинаково важны. Конечно, без работы нет документации.
Я помню, как несколько лет назад на одной из моих предыдущих работ я работал на износ, чтобы выполнить свои задачи. Однако при этом, в конце дня, у меня едва хватило душевных сил, чтобы обновить мои задачи, статус и краткое описание.
Я также не подготовил документацию о том, что я делал. Некоторое время спустя, несмотря на то, что я выполнил свою работу, которая в конечном итоге была запущена в производство, руководство среднего звена было убеждено, что я выполнял работу некачественно или вообще не выполнял ее. Тем не менее, я присутствовал в офисе каждый день, усердно работая над каждой задачей, которую мне ставили, присутствовал на ежедневных стендапах.
Единственное, с чем я столкнулся, это обновление статуса моих задач в инструменте управления задачами. С тех пор, в моих следующих ролях, я сделал это приоритетом. Это снизит вашу производительность в целом, но прояснит ожидания, что вы также документируете весь процесс.
Кроме того, выполнение только работы не создаст впечатления, что вы работаете, потому что другие не могут видеть то, что вы делаете, особенно учитывая глубину предмета. Документирование работы и объяснение ее другим — даже краткое — создадут наилучшее впечатление о вашем прогрессе, даже если вы застряли и работаете медленно.
Характер работы разработчиков и творческой деятельности в целом таков, что наши требования постоянно развиваются. Представьте, что вы работаете над новой функцией и завершили ее. Затем, две недели спустя, требования меняются. Вы также завершаете это. Таким образом, в сознании других людей, особенно нетехнических, они могут не знать объема работы, которую вы проделали, особенно в первой итерации.
Для технических коллег объяснение им даже вкратце делает вашу работу более заметной, в результате вы становитесь более заметным. Этот документ или комментарии к задаче помогут другим позже.
Изложение против первоначального проекта
Я обнаружил, что смесь наиболее эффективна для меня. Мозг лучше всего работает, когда проводит мозговой штурм идей без первоначального анализа структуры в контексте. Обычно он действует беспорядочно, связывая одно с другим. Подумайте о картах разума. Он просто соединяет одно с другим.
Если вы собираетесь начать с форсирования структуры в своем первом наброске, вы можете столкнуться с блоком писателя.
Картинки
Используйте изображения как можно чаще. Картинка означает 1000 слов. Это также более продуктивно, поскольку вам не нужно всегда полностью описывать контекст.
Инструменты редактирования
Обычно я использую разные инструменты редактирования в зависимости от характера работы, например, notion для своих сообщений в блоге, чтобы я мог редактировать контент на другом компьютере. В своей работе я предпочитаю использовать Microsoft Word, так как он сразу поддерживает изображения. Я также использую Typora для общих чертежей.
Использование хорошего инструмента редактирования имеет множество преимуществ, таких как:
- выделение грамматических ошибок
- минимальный интерфейс для уменьшения отвлекающих факторов
- элегантный пользовательский интерфейс с красивой типографикой
Первоначально опубликовано на http://abdallahyashir.com 17 сентября 2021 г.
