Никто никогда не требовал от меня написания какой бы то ни было документации, но что мне отсутствие указаний! Если хочу, если чувствую, что это полезно и правильно, – буду писать сама и своих ребят заставлю.
Откуда у меня такая убеждённость в необходимости внутреннего документирования? Думаю, как-то повлияла необходимость разбираться в чужом объёмном коде, быстро и без возможности пообщаться с авторами, в большой и запутанной системе, и снова быстро, быстро, быстро… Я начала записывать что-то сначала для себя, локально, затем перебралась на удобный wiki-движок. Ну да не в инструментах дело.
За несколько лет я немного поняла, что, как и для кого надо писать. Готова поделиться.
Подробнее