Hot answers tagged

46

Simple: Release a beta version! Then when documentation is done, do final release of the new version. If you have users willing to try out the new stuff, then by all means take advantage of that. You will get bug reports, you probably get community questions about the difficult points so you know where to concentrate on the documentation, etc. You may also ...


15

If I got you right, you are doing this project on your free time and for no money. If this is the case, then please, do what makes you feel better (users wait, document on your time). You should not feel the pressure from your "users". Many people wrote about this on the Internet (Large FLOSS authors and contributors who felt the pressure). But, if you are ...


4

In general there are two types of documentation: the technical which documents your code (classes, units, etc) and how new features may operate and being implemented in the code and user documentation. IMO, technical documentation is a must especially if software development is not your full time job. I spend lots of time on this as I may have large gaps ...


4

The thing is I don't know if I should document my overloaded operators, I mean, it is kind of obvious, isn't it? Simple answer: Then it won't take you very long to document it, will it? Just do it! Complicated answer: You're writing this documentation for someone to use, not for its own sake. Who are you writing it for? How are they going to use it? ...


3

Just to add something not only for this specific example but for general workflow: Documentation might be your definition of done, but documentation is most of the time beyond a minimal viable product (MVP). Not only is the customer always right. If it is a commercial product, releasing might be a lot of business value and is an absolute priority. The ...


2

You have not clarified in your question and probably not to your users the consequences of these choices. How much time are you spending on user support? Will additional documentation decrease the amount of time you spend on support or increase sales? What is the advantage to you to do documentation? Your users want new features over documentation, but do ...


2

New features make old users happy. Good documentation invites new users. Which you should concentrate on depends on which you're more in need of. You indicated the user base was healthy so new features can wait. Speaking as an old user, I like good documentation as well. Nice thing about open source: old users add their own features.



Only top voted, non community-wiki answers of a minimum length are eligible