Публикации по теме 'documentation'


Документ сначала! Сделайте это частью процесса, а не дополнением
Мы все были там, последний рывок, завершение спринта, много вещей, которые нужно сделать, но не хватает времени. Часы тикают, и мы едва доберемся до финиша. Пора начинать приносить жертвы. Да начнется игра в шахматы Программирование похоже на игру в шахматы. Вы должны защитить самые важные части: результаты вашего кода. Как и в шахматах, первая жертва — это пешки. Конечно, они играют важную роль на доске, но давайте же, вам нужно защитить короля и выиграть игру! Время уходит, пора..
Использование диаграмм.net для создания диаграмм UML
Мой любимый инструмент на данный момент Фон [Эта статья не спонсируется, и диаграмма.net в любом случае является бесплатным инструментом] Я использовал инструменты Visual Studios UML, а также AstahUML, который поставляется бесплатно с адресом электронной почты студента. Ни один из этих инструментов не является бесплатным, и, кроме того, они сложнее в использовании и менее интуитивны, чем диаграмма. Разговор о выигрыше для меня. Я считаю, что на диаграммах.net также есть очень..
Создание документации API для пакетов TypeScript с помощью TypeDoc
Лучшая документация для лучшего обслуживания пользователей вашего пакета С помощью TypeDoc можно добавлять структурированные комментарии (комментарии в стиле JSDoc) к исходному коду TypeScript. Используя данные в этих комментариях, TypeDoc создает хорошую документацию по API, которую вы можете легко опубликовать на веб-сайте. С добавлением еще одного инструмента, gh-pages , документацию на GitHub Pages легко опубликовать. Важно опубликовать API в пакете, показав функции,..
Участие в проектах с открытым исходным кодом в качестве младшего разработчика — часть 2
В предыдущей части я пытался найти репозиторий с открытым исходным кодом, в котором есть легко исправляемая ошибка или простая в реализации функция для младшего бэкенд-инженера, такого как я. Я потерпел неудачу и разочаровался через час, который записал в виде статьи ЗДЕСЬ . К счастью, это не было пустой тратой времени. Я думаю, что эта интернет-охота за мусором никогда не бывает. Вы либо найдете интересную информацию, либо обнаружите, что родинка, которая у вас есть, действительно..
Лучшие практики для документирования компонентов React
React продолжает усложняться с каждым выпуском, и для команд разработчиков на основе React стало крайне важно создавать эффективную внутреннюю документацию. Давайте посмотрим, как мы можем сделать именно это, сделав документацию не только менее болезненной, но и приятной для работы. Хорошая внутренняя документация — это не только вопрос написания технического справочника, но и то, насколько легко вы можете создавать и поддерживать документы, насколько легко вы можете с их помощью..
Создание пользовательских предупреждений в приложении Docusaurus React
Docusaurus — это генератор статических сайтов, помогающий быстро создать сайт документации, позволяющий пользователям сосредоточиться на его содержимом, а не на технических деталях, с помощью текстовых редакторов, таких как VSCode, или систем управления контентом (CMS) , таких как WordPress. Strapi и Netlify CMS. Авторы контента могут использовать эти инструменты и сохранять содержимое в файлах уценки, и он имеет множество готовых функций, соответствующих вашим потребностям. Настройка..
Документация по базе данных: Terra Incognita
Документация по базе данных: Terra Incognita Когда кто-то упоминает документацию по базе данных в ИТ-отделе, все мудро кивают, но стараются этого не делать. Компании редко заботятся о документации базы данных. Кажется, это одна из тех еще неизведанных территорий. Сейчас все знакомы с API или документацией по тестированию, но мало кто действительно понимает, что такое документация по базе данных и нужна ли она на самом деле. Проще говоря, документация базы данных так же важна, как..