Я копирайтер, который пишет контент для широкой публики, но я хочу стать техническим писателем, который пишет документацию специально для разработчиков программного обеспечения. Это мое образовательное путешествие ...

У меня есть опыт работы копирайтером и редактором новостей в технологической индустрии, и я люблю веб-сайты, стартапы, приложения, краудсорсинговые платформы, виртуальную реальность, компьютерную лингвистику, искусственный интеллект и многое другое, что требует на разработчиков программного обеспечения, чтобы увидеть свет. Итак, когда я решил поступить в аспирантуру, чтобы узнать, как стать техническим писателем, я знал, для кого хочу писать; Я хотел писать для волшебников, программистов!

Учимся думать как разработчик программного обеспечения

Однако я понял, что нельзя писать для определенной аудитории, если вы не знаете их языка или того, как они проводят время. Вот почему, помимо курсов по написанию технической документации, я учу себя программированию, культуре гибкой разработки, тому, что делает документацию хорошей / ценной, и всему, что могу, об API, SDK, разработке программного обеспечения и т. Д.

Стажировки будут играть большую роль в моем путешествии, когда у меня будет достаточно навыков, чтобы внести значительный вклад в работу магазина веб-разработки или другой организации. Свяжитесь со мной, если вам интересно!

Моим первым конкретным шагом было изучение JavaScript с помощью учебных модулей, которые я нашел на FreeCodeCamp.org. Я выполнил около 45 коротких упражнений на JavaScript и, как новичок в программировании, вот мои мысли:

1. Примеры кода

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

Любые слова, с которыми вы сталкиваетесь на своем пути к созданию работающей программы, не кажутся вам полезными. Они кажутся вам препятствиями, которые нужно преодолеть, прежде чем вам позволят выполнять «настоящую» работу.

Я так чувствовал, и я люблю слова и письмо! Я могу только представить, что чувствуют другие.

2. Время, внимание и память.

Недавно я прочитал, что когда программисты прерываются, им требуется много времени, чтобы вернуться к работе. Любое прерывание может разрушить сложившуюся в их голове мысленную модель того, как работает логика программирования для приложения или функции.

Я подозреваю, что в основе всего этого лежит высокая последовательность и грамматическая природа языков программирования. Это показывает мне, что программирование требует концентрации (времени и внимания), и показывает, что для быстрого написания кода необходима сильная рабочая память. Учебные модули подтвердили мои подозрения.

Это одна из причин, по которой в прошлом я отказывался от программирования. Когда дело доходит до последовательной информации, такой как инструкции по приготовлению, танцевальные шаги или запоминание произвольных чисел и формул, я не ваш мужчина!

Однако я нашел способ обойти эту проблему, как вы увидите в мысли №4.

3. Значение редакторов Drag-and-Drop / WYSIWYG…

Хотя я только начинаю изучать программирование, я активно использую редакторы WYSIWYG почти десять лет, а за последние несколько лет с помощью Bubble.is мне удалось создать несколько довольно сложных приложений. В качестве примера того, насколько это мощно, я предлагаю вам прочитать эту статью об одном человеке, который перестроил платформу Twitter всего за несколько дней, не используя ни единой строчки кода. Wix недавно выпустил похожую технологию.

В настоящее время я создаю сложную платформу краудсорсинга / краудфандинга с помощью этих инструментов. Это платформа, которая позволяет людям выполнять задачи в Интернете, чтобы зарабатывать деньги для некоммерческих организаций, создающих переносные приюты для бездомных. Вы можете найти страницу, которая скоро появится здесь.

Короче говоря, даже после изучения нескольких базовых навыков программирования я вижу ценность простой возможности манипулировать визуальными элементами и использовать графический интерфейс для создания рабочих процессов, а также настраивать базы данных и т. Д. Подтверждено в десять раз.

4. Мнемоника

Я уже могу сказать, что языки программирования и логика являются шаблонными, и сразу же очевидно, что существует множество правил. Поэтому я думаю, что это может быть идеальным предметом для меня, чтобы использовать тот же трюк, который помог мне пройти через алгебру в колледже и другие предметы с тяжелой памятью и т. Д. Мнемоника!

Короче говоря, как только я узнаю, что прилипает, а что нет в моей памяти, когда дело доходит до JavaScript, я буду использовать методы запоминания, такие как индивидуализированные изображения, предложения, визуальные образы / мысли и рисунки, которые помогут мне получить доступ к конкретной информации. поскольку мне это нужно, чтобы вспомнить вещи.

В качестве примера мнемоники в действии вот одна история, которой я могу поделиться: когда я пытался запомнить международный фонетический алфавит для курса лингвистики, у меня ничего не вышло. Затем я решил просто запомнить большой рисунок, который я сделал с отдельными компонентами, который подскажет мне ответ, если я приглядываюсь поближе и обдумываю каждый из них. В конце концов, я сдал экзамен!

Поскольку я заранее знаю, что изучение JavaScript будет для меня трудным, я собираюсь подготовиться к использованию мнемоники в максимально возможной степени (чтобы убедиться, что она приживается).

Я надеюсь, что у вас будет несколько примеров этого в блоге №2.

Быть в курсе…