© Ben Lopatin 2020
B. LopatinDjango Standalone Appshttps://doi.org/10.1007/978-1-4842-5632-9_19

19. Documenting your standalone app

Ben Lopatin1 
(1)
New York, NY, USA
 

Once you’ve released your standalone app to the world, someone else will want to use it. How will they use it? How will they install it? And does it solve the same kind of problem they have? In this chapter, we’ll look at how you can start addressing the challenge of documenting your standalone app.

Starting with questions

Regardless of what formats and tools you use to document your standalone app, or how you decide to distribute documentation throughout your codebase, all of your documentation should be motivated by answering the questions that someone else – even future you – will ...

Get Django Standalone Apps: Learn to Develop Reusable Django Libraries now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.