TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: New to a system with maintenance in mind and no sparse docs

3 pointsby perlpimpover 3 years ago
I have been hired a year ago to work for a company to maintain and update system that we do not have very good documentation for nor do I have insightful knowledge of the tools that are used to maintain and so on.<p>Wonder if there is a good rule of thumb to keep working on the system if there is a lot of time between support requests. Like writing additional tests, interference testing to find patterns of failure and so on to move to deeper understand it.

1 comment

NAHWheatCrackerover 3 years ago
I find that the best way for me to learn a system is to just clean it up. Making non-functional changes like formatting the code and adding documentation. Maybe refactoring if I see something that could obviously be cleaned up like duplicate code.<p>Testing is also good, if it&#x27;s testable. Based on your description, I&#x27;m guessing it isn&#x27;t very testable. Testing and refactoring together is a good cycle.<p>Setting up a repeatable environment is huge help. Build&#x2F;test should run on every commit in CI. Dockerize it if it isn&#x27;t already. Have as many official environments as you see fit. At least a dev that is kept up-to-date and production, of course.