Как записать техническую документацию веб-сайта / программное обеспечение для новых разработчиков? [закрытый]
Не используйте RSA, так как ECDSA является новым значением по умолчанию.
На сервере делают это: ssh-keygen -l -f /etc/ssh/ssh_host_ecdsa_key.pub и запись то число.
На клиенте Вы можете SSH к хосту и если и когда Вы видите то же самое число, можно ответить на подсказку Are you sure you want to continue connecting (yes/no)? утвердительно. Затем ключ ECDSA будет зарегистрирован на клиенте для будущего использования.
4 ответа
Быстро и ясно:
Думайте об этом как о любом документе.
Какова цель приложения (веб-сайта)? [почему?]
Как достигается эта цель?
Какие проблемы возникли?
Какие проблемы могут возникнуть?
Что можно было бы расширить? [почему?]
Какие проблемы может вызвать расширение? [почему?]
Какие соглашения об именах / форматировании следует соблюдать?
- Формат структуры отличный.
В дополнение к предложению Ноны я бы также сказал, что важно разбить код и объяснить любые соглашения и намерения кода, чтобы между разработчиками было единообразие таких вещей, как значения идентификаторов, Классы CSS и имена функций JavaScript. Будьте настолько конкретны, насколько сочтете необходимым, чтобы не дать новому человеку в команде заново изобретать работу.
Если вы ищете быстрый способ разобраться в коде, попробуйте .NET Reflector . Он дает вам широкий обзор всех ваших классов, методов, свойств и т. Д., Так что вы можете писать всю необходимую техническую документацию, не просматривая файлы. Его очень легко просматривать, и он даже покажет вам сам код.
Задумывались ли вы о представлении того, что существует, с помощью некоторой нотации UML? Вот для чего нужен UML! Если новые разработчики хороши, они должны уметь это понимать.