Что эффективные пути состоят в том, чтобы сделать заметки “программиста”? [закрытый]

Похоже, что все согласны с тем, что лучше всего использовать блоги или физические записные книжки. За исключением этого, вы можете использовать вики или приложение, например OneNote.

См. Этот вопрос: https://stackoverflow.com/questions/78756/what-do-you-use-to-keep-notes -as-a-developer

Хотя это не Помимо всего этого, я стал большим поклонником Hipster PDA .

(Короче говоря: стопка карточек 3x5 и скрепка для бумаг. Это действительно очень полезно.)

Я большой поклонник Todoodlist Ника Серниса .

• Отслеживание ошибок для заметок, касающихся расследования конкретной проблемы. Это может включать тестовый код, выходные данные журнала, обновления того, как вы сужаете круг вопросов и что вы исключили. Я пытаюсь предположить, что меня переедет автобус, и завтра ошибку возьмет на себя кто-нибудь другой. У них будут заметки в системе отслеживания ошибок, любой код в моем текущем рабочем каталоге на моем ПК, и можно предположить, что они не могут читать мой почерк. Они хотят быть там, где я был, не позднее 10 утра. Он обязательно должен включать полное описание проблемы, которая вызвала ошибку, и способы ее исправления для исторической записи. Это то, к чему вы придете, когда кто-нибудь спросит: «Что это за исправление?». Постоянная деталь - это то, на что вы ссылаетесь, если кто-то говорит: «Я видел похожую проблему где-то еще, или, по крайней мере, в трекере ошибок (который объясняет, что было не так с предыдущим кодом, тогда как комментарии объясняют, что правильно с текущей версией).

  Примечания типа «что мне нужно было сделать, чтобы установить IDE? и работает », конечно, заходят в вики или блог. Что-то общедоступное или то, что ваши коллеги могут видеть и искать, но которое является специфическим для вас, потому что вы, скорее всего, захотите это.

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

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

В зависимости от вашей среды вы можете создавать собственные теги в соответствии со строками // TODO: Кроме того, вы должны настроить свою систему управления версиями на отказ от проверок без комментариев.

Абсолютно лучший способ задокументировать что-то с течением времени, чтобы вы знали, что вы сделали, и чтобы следующий человек знал, как это поддерживать, - это модульные тесты на все ваших изменений. Переключитесь на аннотированное представление источника для модульных тестов, и у вас есть дата и время.

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

Я давно использую записные книжки Moleskine, и всякий раз, когда я перехожу к чему-то другому (я использовал OneNote, WikidPad, Tomboy и т. Д.), Я всегда возвращаюсь к своим записным книжкам

Moleskine имеет все размеры, не говоря уже о трех типах бумаги: обычная, линейчатая, сетка

http://www.moleskines.com/moleskine-softcover-xlarge-squared.html

Надеюсь, это поможет

Я использую cat >> ~ / TODO , веду блог или записываю в блокноты (физические).

Моя собственная система:

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

Обычно все начинается в OmniOutliner, а затем копируется и вставляется в другие системы по мере необходимости.

My Поиск Macbook в центре внимания хорош для поиска вещей, поэтому я не слишком беспокоюсь об организации.

Я нашел TodoList на этом сайте: http://www.abstractspoon.com/ Он прост в использовании, не требует установки и имеет приятные функции.

А для дальнейшей обработки заметок я бы рекомендовал WikiPad , который позволяет структурировать информацию.

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

Бумага + ручка по-прежнему прекрасный инструмент.

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

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

Я обнаружил, что TiddlyWiki действительно удобен. Это автономная вики, которую я использую, чтобы вести записи обо всех вещах - от моего личного дела до заметок о реализации определенных функций. Объедините это с Dropbox , и он появится во всех моих системах.

Вам нужна простота, чтобы можно было быстро ее освоить. Я использую текстовый файл и добавляю его на рабочий стол и сохраняю стандартное имя, например NOTES, NOTES2 в формате README или TODO, с датой всякий раз, когда вы добавляете новые записи.

Все будет работать, если это просто. Если вы начнете добавлять серверы, вики и все такое, то вы слишком усложните то, что хотите.

Я практичный минималист.

Notepad ++ открыт на моем правом мониторе каждый день. Я добавляю к нему, когда считаю нужным, но я всегда помещаю заметки в Subversion, когда фиксирую изменения. Все быстро меняется.

Раньше я много использовал tiddlywiki, но Notepad ++ работает лучше для меня и урезан до того, что мне нужно - места для ввода, которое я могу искать позже. Что мне не нравится в физических ноутбуках, так это то, что я должен быть поисковой машиной, когда ищу что-то в одном.

Вот как я это делаю.

Блог об этом. Или настройте внутреннюю Wiki для заметок разработчика.

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

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

Часы работы - 8:00

Анализ - 10:30
Описание проделанной аналитической работы.

Кодирование - 12:30
Описание всей проделанной работы по кодированию.

Идея состоит в том, чтобы доказать клиенту, что вы не были в StackOverflow весь день, когда выставляли ему счет. В результате вы регистрируете все выполняемые вами кодирование, отладку и т. Д.

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

• иметь блог, даже если его никто не читает. Напишите статью / как / что-я-сделал обо всем, что вы выяснили и что, возможно, захотите вспомнить через месяцы или годы. Кто знает, кто-то еще может счесть это полезным.
• используйте Trac или Github, которые предоставляют хорошую вики для каждого проекта. В дополнение к сообщениям о фиксации вы можете вести заметки и инструкции в вики, относящиеся к проекту. Обв. это помогает в документации и остальной части вашей команды
• для краткосрочных заметок, держите блокнот и карандаш под рукой. Но если вы похожи на меня, вы потеряете или потеряете эти вещи в ближайшее время
• держите файлы TODO и CHANGELOG в каждом проекте. Иногда очень сложно поддерживать, но у меня было много раз, когда они спасали мою ##
• , если она действительно важна, делали ее татуировку на руке, как тот парень из Memento.

У меня довольно плохая память, и я не ожидаю, что что-нибудь вспомню через 2 недели (часто помню, но в то время вы не можете предсказать, запомните ли вы данную вещь). Так что это мои адаптации, и они работают очень хорошо.

Стол + Crayola

Хорошая система управления исходным кодом с хорошими комментариями к коду и хорошей политикой проверок комментариев творит чудеса.