8 шагов к идеальной бумаге
Я пишу для среды уже почти два года, за это время я опубликовал около ста пятидесяти с лишним статей, почти все технические о кодировании на Swift, языках, используемых для создания приложений на устройствах Apple. Я делаю это по нескольким причинам.
- Это держит меня в здравом уме, в мире, который, кажется, разваливается; как лично для меня [без FTJ], так и для всех нас, я боюсь [глобальное потепление, вот и мы].
- Чтобы помочь мне понять, как лучше программировать, потому что научиться программировать на самом деле можно только — кодируя — и что ж — они продолжают двигать цели, не так ли.
- Чтобы доказать миру в целом, что я все еще могу программировать, что для таких программистов, как вы и я, кажется все более сложной задачей, поскольку в наши дни кодировать может каждый — правда.
- Это весело, нет, мне действительно это нравится.
Так что вы можете себе представить, как я был счастлив, когда связалась с компанией, которая попросила меня помочь им написать блог. Еще лучше, если темой блога будет [новый] фреймворк SwiftUI от Apple. Они прислали красиво спроектированный код и попросили меня написать об этом статью.
Я просмотрел код, там было всего сто строк и попытался сделать так, сделав несколько дополнений, как и я. Им не нравились мои дополнения к коду или мой первоначальный набросок — нет, они хотели чего-то другого.
Они дали мне второй шанс сосредоточиться на сотне строк, которые они мне прислали, без дополнений, пожалуйста. Я набросал то, что мог, но, подумав неделю, они тоже отвергли и меня уволили — это был недолгий успех.
Я был раздавлен, нет — нет. Это было отличное упражнение, и я уверен, что кое-чему научился, читая их код, даже если мне нужно забыть об этом, как это предусмотрено соглашением о неразглашении. В любом случае, продвигаясь вперед, я подумал, что попытаюсь написать статью о написании статьи, хороший технический документ — и предложить вам, читатель, согласиться или не согласиться в комментариях — пожалуйста, сделайте это.
Итак, что делает газету хорошей, а что нет.
Частичный код
Хорошо, я должен сосредоточиться на положительном, но эта черта меня так раздражает, что я должен упомянуть о ней. Если вы пишете техническую статью, не ожидайте и не предлагайте, чтобы мне нужно было закрыть приложение, чтобы протестировать его позже — если я использую компилятор и пишу код, это потому, что я хочу написать приложение с звуковым сигналом, а не загрузить его.
Сломанный код
Я признаю, что делал это по крайней мере один раз — вы найдете много таких на веб-сайте StackOverflow. Особенно со Swift, который является быстро движущейся целью. Убедитесь, что код, который вы публикуете, работает! Убедитесь, что вы публикуете полное решение, без частей, пожалуйста -
Код токена
Я перейду к тому, что делать через мгновение, но это тоже важно. Вы также найдете много этих документов в Интернете. Код, в который встроены идеальные параметры, которые гарантируют, что он сломается, как только вы попробуете технику где-нибудь еще — нет.
Идеальная бумага
- Я пытаюсь написать историю — с небольшой предысторией.
- Я пытаюсь написать бриф — объяснить, о чем статья.
- Я стараюсь повысить ценность представленных статей — уже существует множество статей о реализации фреймворков Swift.
- Я стараюсь говорить о том, почему я что-то сделал, а не только о том, как я это сделал — это важно в мире, где есть восемь способов сделать одно и то же, с одним или двумя лучшими решениями, скажем так.
- Я пытаюсь добавить анимированные GIF-файлы, чтобы показать, о чем я говорю, статический контент предназначен для PDF-файлов, а не для пользователей Интернета.
- Я стараюсь уложиться в тысячу слов или меньше. Вам нужно тратить время на кодирование, а не на чтение!
- Я стараюсь включать в статью целые блоки кода, а не фрагменты — чтобы вы, читатели, должны были как-то собрать их воедино, придать мне сил.
- Я стараюсь [иногда] писать заключение, чтобы подытожить то, о чем я говорил.
Все это подводит меня к концу этого произведения. Теперь вы знаете, что работает — напишите код с добавленной стоимостью и задокументируйте его на носителе. Киньте ссылку в комментарии, я почитаю, скажите, работает ли и у меня.
