Home

Welcome to the Wiki of the Alan IF Documentation Project.

The goal of this Wiki is to provide guidelines on how to maximize productivity in your ALAN projects, with an emphasis on documentation.

Since the ALAN IF community has a rather small and tight-knit userbase, we've worked together in the course of time to share our experiences and come up with commonly shared assets and strategies that would allow us to reduce maintenance redundancy. This Wiki is the central place were such strategies, tools and assets are documented and shared, for the benefit of anyone wishing to adopt them in their projects.

Whether you're crafting a text adventure, writing an ALAN tutorial, guide, manual or a full fledged book, this Wiki will allow you to improve your project by:

• Adopting an automated workflow capable of integrating into your project's documentation your adventure's sources and their auto-generated sample transcripts, so that you won't have to manually update your documentation every time you edit the sources of your adventure or the code examples of your book.
• Setup a robust test suite, capable of intercepting bugs and undesired consequences of code changes, to ensure that your adventure grows consistently, without breaking any previous game logic, and that no stone is left unturned when it comes to predicting possible players' actions.
• Many other useful tips & tricks...

Right now, this Wiki is still a work-in-progress in its early stages.