4 ms·

The main work with wikis, is keeping them up to date. Worse than no documentation is wrong documentation in my experience. So if there is a vibrant community,

• 6510 3y ago
  I've pondered how one could set up conditions in documentation. For example display [collapsed] code in the document that implements the functionality there described. If the exact code is no longer found in the source the article or section gets a warning banner, a [collapsed] div view and the wiki bug tracker displaying the issue. Perhaps one could also programmatically generate a list of missing articles by looking at code and implementations.
• midasuni 3y ago
  I Try very hard to explain why we don’t document facts on our wiki, but concepts, with links to facts. We aim to maintain a single source of truth of what should be, and have automated systems to tell us what is. Want to know what ip server “lon-rds14” should be? Ping it. DNS is driven from the ip mgmt tool, job done. Check the auto populated cmdb which will tell you the current interfaces on a given host to tell you what ip it really is. Want to know where on the network it is? Search the portmapper, which tells you (through switch labels) where the host should be, and through mac/ip/dns where is actually is (cmdb also has the lldp entry - duplicating data that automatically updated is fine) On our work wiki (20k users), different departments copy and paste information from one page to another so it’s in “their” area. Even worse one department locks down its area so it’s hidden to those outside the department!