Надеюсь, я никого не беспокою этим вопросом. Моя техническая документация разбросана по разным методам, вот список наиболее часто используемых:
Недавно я начал самостоятельно изучать ИТ-сертификат, и все свои записи у меня в блокноте. Я не знаю, как лучше всего поддерживать доступность и актуальность моей документации.
Что бы вы мне посоветовали?
Комментарий joeqwerty правильный, это полностью субъективно. Тем не менее, если вы посмотрите на некоторые из старых вопросов и ответов по тегу документации, есть много хороших предложений.
Чтобы ответить в более общем смысле, я думаю, что основные требования к хорошей системе документации:
«Лучшим» является любое сочетание общих файлов, sharepoint, вики, документов, хранящихся / реплицируемых в облаке, и т. Д. И т. Д., Которое лучше всего подходит для вас.
Я использую Google Docs, и меня это устраивает ...
На моем рабочем месте у нас есть общий ресурс CIFS, заполненный тоннами документации (в основном это PDF-файлы от производителей и т. Д.), Которые мы используем. Что делает это удобным, так это то, что можно хранить любые типы данных, и для доступа к ним вам нужен только удаленный доступ к вашему рабочему компьютеру.
Тем не менее, для чисто текстовой документации я обнаружил, что настроенная мной вики (с помощью Mediawiki) очень удобна. Он помещает всю вашу документацию в базу данных с контролем версий, чтобы вы могли видеть, какие изменения были внесены, когда и кем. Это также позволяет очень легко находить то, что вы ищете, и перемещаться между разными документами. К сожалению, большинство моих коллег не хотят использовать эту систему, потому что им не нужно беспокоиться об изучении синтаксиса Mediawiki, каким бы простым он ни был. По крайней мере, это облегчает мне жизнь, когда я возвращаюсь к работе над тем, что настроил несколько месяцев назад.
Я использую библиотеку документов Sharepoint. Это позволяет мне создавать и загружать документы Word, Excel, PDF и т. Д. Таким образом, мне не нужно конвертировать или сохранять мою документацию в определенном формате файла (кроме того, что это тип файла, поддерживаемый библиотеками документов Sharepoint).