Ответы пользователя по тегу Документация
  • Почему js код мало документируют?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    Документируются только сложные участки кода, сложная логика обработки/вычислений, особенные методы в классах и неявные (по коду) подписки на события.

    Откройте код игрового "движка" на js или encrypt/hash-библиотеки на js, и сразу увидите коментирование кода в сложных (для понимания) местах.
    Ответ написан
    Комментировать
  • Какие сайты имеют документацию на множестве языков?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    Debian.org
    Доступные языки
    Эта страница также доступна на следующих языках:
    عربية (Arabiya) Български (Bəlgarski) català česky dansk Deutsch Ελληνικά (Ellinika) English español Esperanto فارسی (Farsi) français Galego Հայերեն (hayeren) hrvatski Indonesia Italiano עברית (ivrit) 한국어 (Korean) Lietuvių magyar Nederlands 日本語 (Nihongo) norsk (bokmål) polski Português română slovenčina suomi svenska தமிழ் (Tamil) Tiếng Việt Türkçe українська (ukrajins'ka) 中文(简) 中文(HK) 中文(繁)
    Ответ написан
    6 комментариев
  • Как начать понимать различные документации?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    Лучше всего у меня получается разобраться с помощью видео-обучалок на Youtube например.
    Не обманывайте себя: yt поможет разобраться только при работе в интерфейсе (тот же Unity, например, т.к. там много манипуляций dreag-n-drop), но не глубже.

    Документацию можно читать с любого места, когда суть строения приложения (какой модуль за что отвечает и т.д.) Вы чётко понимаете.
    Иначе - только с самого начала, постепенно разбираясь, осознавая и вникая самостоятельно: БЕЗ РОЛИКОВ!
    Ролики - только после того, как у Вас сложится в голове некоторое структурное понимание после личных проб и ошибок при тестах. Обучающие видео-уроки/видео-ролики - сразу лучше ищите ТОЛЬКО ОФИЦИАЛЬНЫЕ! Иначе - Вас могут легко ввести в заблуждение неопытные пользователи, "схватившие верха", но не саму СУТЬ!
    Ответ написан
    Комментировать
  • Где вести вики по проекту?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    dokuwiki Есть всё, что нужно! (включая html-разметку и загрузку своих страниц в iframe / popup window)
    Ответ написан
    Комментировать
  • Зачем создают копии официальных документаций?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    www.php.su/project/?about
    Если у Вас возникли некоторые идеи или пожелания, поделитесь ими, воспользуйтесь формой обратной связи, либо пишите мне напрямую на электронную почту: traskyy@gmail.com

    С уважением, Андрей Транский, создатель и администратор портала PHP.SU.

    14.05.2006
    Пишите ему и узнаете.
    Ответ написан
    Комментировать
  • Инструмент для групповой работы над документом?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    По-шагам:
    1. Заходим https://cryptpad.fr
    2. Создаём нужные документы: 1 документ - это один раздел (область для редактирования)!
    3. При создании и открытии в каждом документе жмём на share-button("поделиться"):5a72b11d07c27715154980.png4. Ставим настройки: 5a72aec4dd59b395995530.png
    5. Копируем линк из области, выделенной прямоугольником. (проделываем для всех нужных документов)
    6. Вставляем себе куда угодно в HTML-код страницы (запуск из HTML-файла локально - тоже работает!):
    <iframe width=100% frameborder=0 src="[СЮДА_ВСТАВИТЬ_URL_ДОКУМЕНТА_1]"></iframe>
    <iframe width=100% frameborder=0 src="[СЮДА_ВСТАВИТЬ_URL_ДОКУМЕНТА_2]"></iframe>
    ...
    <iframe width=100% frameborder=0 src="[СЮДА_ВСТАВИТЬ_URL_ДОКУМЕНТА_N]"></iframe>

    После этого получаем общий вид документа с реал-тайм редактированием (collaborative work) и с разграничением доступа.
    Ответ написан
    2 комментария
  • В каком формате писать документацию по программе?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    1. Для Документирования JS-кода: documentation.js.org
    2. Для блок-схем (включая погружение drill-down по клику в другие связанные схемы) https://www.edrawsoft.com/
    Ответ написан
    Комментировать
  • Какой выбрать helpdesk?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    Поставьте CMS Joomla!-у и дайте права пользователям создавать публикации в конкретном разделе - это будут тикеты. Кастомные/произвольные поля для публикации - можно настраивать из админки. Эта функция есть сразу после установки "из коробки"!
    В другом разделе - храните документацию.
    Любая настройка стилей и внешнего вида.
    Платить - никому не нужно будет.

    Список OpenSource Help-Desk систем
    Ответ написан
  • Какой движок выбрать для документации?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    Если Вы привыкли к WYSIWYG-редакторам, я бы посоветовал использовать ту же Joomla!-у с плагином автоматического кросс-линкинга между статьями, который сам создаёт ссылки, если видит упоминание на уже описанный объект.
    Это довольно-таки удобно и Вы пишите в привычных условиях.
    Также в Joomla есть создание пользовательских полей для статьи БЕЗ ПЛАГИНОВ, СРАЗУ "ИЗ КОРОБКИ" после установки.

    PS: Если нужна помощь - я готов поучаствовать за недорого в создании подобного сайта. (т.к. я сам перевожу разного рода документацию и мне тоже это потребовался бы подобный функционал)
    Ответ написан
    Комментировать
  • Как документировать поля форм (в т.ч. валидацию, логику), api, БД?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    Все эти поля связаны кучерявой логикой.
    Возможно руки растут так
    Улыбчиво)))

    Идите от роли:
    Роль/объект в системе (или класс) - это будет существительное => сущность в БД (товар, пользователь, статья/публикация, комментарий и т.д.).
    Свойства роли (или свойства объекта класса) - это прилагательное => свойства сущности в БД (цвет, вес и т.д.).
    Манипулятор (возможные действия роли/объекта; методы объекта класса) - это глагол => таблица Activity сущности в БД.

    Затем - делаете обычное документирование этих классов (оно же API).

    Всё, что у Вас в находится в полях форм в различные моменты времени - это частный случай взаимодействия объектов классов и/или других вспомогательных блоков.
    Поэтому, каждая форма - документируется в виде перечня параметров с указанием типа поля и класса со свойством для каждого поля формы.
    А вот переходы между формами - уже оформляются как схема бизнес-процесса.
    Ответ написан
    Комментировать
  • Где посмотреть пример хорошего ТЗ?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    здесь
    1. Описание назначения продукта
    2. Технологии реализации (железо, ОС, ЯП, фреймворки, библиотеки и т.д.)
    3. Список ролей п...
    ...
    10. Требования и порядок для ввода готовой системы в промышленную эксплуатацию.
    Ответ написан
    Комментировать
  • Кто каким образом документирует локальную сеть?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    Да HTML обычный.
    Схема: в SVG, по клику на объекте - инфа.
    Проверка доступности хостов/портов: через коды статуса аякс-запросом.
    Нужно более круче: берём webkit и вперёд допиливаем.
    Ответ написан
  • Стоит ли создавать дополнительные переменные для лучшей читаемости кода?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    2-й.
    он не только более короткий, но и намного менее ресурсозатратный.
    Ну, и... "ломик в рукаве": php.net/manual/ru/function.array-sum.php
    Ответ написан
    4 комментария