Техническое описание: Как записать [закрытый] тот
Ну, просто, чтобы закрыть это: моя проблема возникла из-за запуска nuxt в качестве приложения узла, которое не понимает операторы импорта ES6, которые появились в моей конфигурации nuxt.
Поэтому мне пришлось переписать вещи, чтобы работать с commons.js (require).
Это работает на данный момент. (Я также пытался запустить babel-node при запуске server.js, но безуспешно. Это не значит, что это не сработало, я просто не хотел стараться изо всех сил).
Спасибо за комментарии. веселит
6 ответов
Да, попытайтесь прочитать другие технические описания. Но только прочитайте любой отчет. Считайте лучшие. Вы можете обычно , определил, который является "лучшим" путем проверки, сколько раз была процитирована бумага (Один веб-сайт, в который я перехожу для этого, , цитируют провидца и ученый Google). Некоторые общие руководящие принципы были бы:
- Попытка быть прямым к точке, не ходить вокруг да около.
- Использование Ваши акронимы последовательно.
- Пользуются возможностью для утверждения слабых мест предыдущих методов, как он вид шоу, Вы вставили усилие рассмотреть/рассмотреть методы других.
- технический документ А должен быть очень конкретным. Состояние точно, как Ваш метод работает, указывают точно, как Вы проводите эксперименты (так, чтобы другие могли копировать Ваши эксперименты), указывает точно Ваши результаты (много графиков было бы хорошо), и наконец, завершите это в 40-60 словах или около этого.
- Акцент на материал, которые являются новыми (Материал, который Вы предлагаете) и меньше на материале, которые стары (Который был бы Вашим образованием). Ясно дайте понять различие.
- Обычно Вы не включаете свой исходный код в Вашу статью. Если Вы должны, опубликованный в веб-странице вместе со ссылками на Вашу статью.
P/S: Мой совет немного склоняется к научной работе. Но я думаю, что это должно применяться в Вашем случае.
Цель отчета состоит в том, чтобы обычно защищать конкретную точку зрения или предлагать определенное решение проблемы.
, Если, однако, Ваш отчет сталкивается как немного больше, чем маркетинг или коммерческая цель, Вы не будете делать очень хороший случай. Стандартный совет состоит в том, что необходимо начать путем артикулирования потребности, которую имеет аудитория ('болевая точка' в bizspeak), и обратитесь решению той потребности.
Мои 0.02:
Read пара и попытка сделать интеллект-карты, пытающиеся придумать идею того, как они похожи.
После того, как Вы сделали этот анализ, возвратитесь и выберите разделы, в которых испытывает необходимость Ваше техническое описание. В частности, создайте ДРУГОЙ интеллект-карта с Вашей структурой документа.
Данные являются также важным способом передать информацию. Так, думайте некоторое время о методах Визуализации Данных прежде, чем строить диаграмму Ваших данных.
Это звучит немного бесполезным, но отчеты появляются во все формы от очень определенного до очень общего. Определите, какова конечная цель. Вы пытаетесь продать что-то или описать, как работает новый технический виджет, или опишите опыт? Кроме того, решите, что Ваша аудитория - они бизнес, технический, размещает и т.д.
, Смотрят вокруг на примеры - большинство крупных компаний (IBM и т.д.) имеет сотни на своем веб-сайте. Считайте некоторых и посмотрите то, что кажется тебе положительными и отрицательными сторонами.
, Как Написать Техническую Работу †“Техническое описание на Технических описаниях
, автор той части также записал книгу:
Пишущие Технические Работы: Как Получить Читателей И Сохранить Их Занятыми
Техническое описание могло быть или общим или очень конкретным. Это зависит полностью от предмета, аудитории и намерения.
, Например, статья о теме R+D, или представленный в академии или разработанный для обеспечения концептуального эскиза некоторой будущей работы будет записанной в более пассивном залоге, почти формат Q+A. Обсуждение. Вы, вероятно, представите несколько идей, и мог бы про/обманный их, обязательно не сделав фиксированного вывода.
техническое описание А на конкретной технологии, для преимущества клиентов разъяснения, или проиллюстрировать или зарегистрировать некоторый результат будет очень фирмой, зафиксированной, и иметь определенные заключения. Числа.
единственная вещь, которую можно сказать обычно, состоит в том, что процесс работает от неопределенного-> конкретный.