#Updating Documentation ####The goal of this file is simply to offer a comprehensive checklist of things we must check when updating the documentation.
- Changelog:
- Is Changelog.md up-to-date with the latest release?
- Is it in the proper Keep a Changelog format?
- Build instructions:
- If a programmer who never built FSO before read the build instruction at Readme.md, would they manage to build FSO?
- Is the information in the file up-to-date regarding other matters (such as versions of tools mentioned, links to other guides, etc.)?
- Is the information in the Building article, and its sub-articles, still up-to-date?
- Forums:
- Does the Forum contain enough clear information to help a new developer find their way into the up-to-date instructions?
- Is there anything that might mislead a new developer to stumble onto old tools, dead links and/or old versions of the project?
- General documentation files:
- Is the information in the following files up-to-date?
- About.md (Should contain general information about FS, FS2, HLP, FSO and FSU)
- Authors.md (Should contain information about the original developers, a way to see FSO's contributors, and special thanks to Volition and Dave Baranec)
- Copying.md (Should contain Volition's Copyright terms and a way to check FSO's Licensing info)