ОтКак упаковать ваш пакет LaTeXруководство:
«Важными частями пакета являются код, документация кода и пользовательская документация».
В чем разница между документацией кода и пользовательской документацией?
решение1
Ну, несмотря на это jjdb попал в точку:
документация пользователя = руководство пользователя, документация кода = руководство программиста
Попробую быть немного более поэтичным:
Руководство пользователя, как следует из его названия, предназначено для использования пользователем, т. е. парнем, который сидит за компьютером и использует ваш код для выполнения любых необходимых ему действий.
Документирование кода является частью надлежащей практики, которой придерживается программист, чтобы отслеживать свою работу, оставлять понятные сообщения всем, кто хочет прикоснуться к коду, и сохранять здравый смысл (особенно после длительных периодов бездействия по отношению к коду).
По сути, пользовательская документация должна быть максимально понятной, поскольку вы не знаете, каков уровень понимания пакета у человека, который ее читает (помните, что если это первая версия, то, скорее всего, никто ее раньше не видел), в то время как документация по коду должна быть ориентирована на демонстрацию того, что и где делает ваш код, чтобы любые изменения можно было вносить максимально просто.