Публикации по теме 'documentation'
Документация: это больше, чем просто слова
Разработка программного обеспечения - это не только общение, но и функциональность. По своей сути код отражает бизнес-процессы и бизнес-логику. Программное обеспечение никогда не существует исключительно в вакууме, оно окружено как контекстом, так и людьми. Отслеживание истории бизнеса и его программного обеспечения становится все более важным фактором всего процесса разработки. В идеальном мире мы документируем изменения, мы пишем заметки, мы добавляем комментарии, и эта документация..
ExDash: внутренняя документация Elixir, интегрированная с Dash
В Urbint мы гордимся тем, что обеспечиваем бесперебойную работу инструментов разработки программного обеспечения. Важной частью этих инструментов является мгновенный доступ к документации через поиск.
В этом посте мы кратко рассмотрим инструменты, которые мы используем для этого, как для внутренней, так и для внешней документации, с Dash, Alfred и новым пакетом Elixir под названием ExDash .
Смертельная комбинация инструментов для документации
Dash - это инструмент для управления и..
Подозрительная документация
Подозрительная документация
В моем стремлении написать свой доклад на LambdaConf о документации, я подумал, что это поможет глубоко погрузиться в некоторые инструменты, которые помогают Haskellerz задокументировать свой код и добавить этот шик в свои библиотеки. Документация очень важна для привлечения пользователей в вашу библиотеку. Если вы мне не верите, то, может быть, вам стоит прийти на мой доклад в июне, надеюсь, тогда я смогу вас убедить :)
В этом посте я расскажу, как..
Немецкий журнал
Борьба с человеческим познанием…
Если вы читаете это, и вы не я, вы, вероятно, делаете это неправильно. Есть статьи , которые тоже почти никем не прочитаны, но рассчитаны на более широкую аудиторию.
Я делаю веб-приложение для себя, чтобы выучить немецкий язык. Причина, по которой я все это записываю, состоит в том, чтобы помнить, чем я занимаюсь — глядя на все изображения, заметки и наброски, собранные годами, я раньше был творческим человеком, человеком, полным идей, оптимизма и..
Как я сделал свою страницу GitHub: часть Javascript
Продолжая мой последний пост , эта часть будет охватывать часть Javascript. Моя страница GitHub: https://kroygis.github.io
Я больше всего боролся с Javascript в этом проекте. Тем более, что я решил придерживаться Vanilla Javascript. Я не хотел загружать всю библиотеку jQuery, потому что моя страница GitHub — это относительно небольшой одностраничный веб-сайт. Таким образом, я поднялся по крутой кривой обучения, но я узнал многому . Я также понял, что принимал так много вещей как..
Docz - Документировать свой проект никогда не было так просто
Docz упрощает написание и публикацию красивой интерактивной документации для вашего кода.
Документирование кода - один из самых важных (и отнимающих много времени) процессов, когда вы создаете что-то новое. Много времени тратится на ненужные попытки создать сайт документации, который будет соответствовать желаемому стилю.
Библиотеки, упрощающие разработку, появляются каждый день.
Руководства по стилю и дизайн-системы становятся все популярнее.
Сегодня необходимы инструменты,..
В конечном итоге о вас будут судить по качеству вашей документации.
Часто, когда я говорю с младшими разработчиками о документации, они сосредотачиваются на «объяснении кода под рукой». Однако это очень узкая точка зрения. Программное обеспечение не существует изолированно. Скорее всего, он существует как часть большого зоопарка различных приложений внутри компании, для которой он был написан. Скорее всего, он существует как часть большого зоопарка различных приложений внутри компании, для которой он был написан. Каждая часть программного обеспечения..
