Open Closed

No documentation for the Blog Module : Please fully document your modules. #739


0
okains created

Check the docs before asking a question: https://docs.abp.io/en/commercial/latest/ Check the samples, to see the basic tasks: https://docs.abp.io/en/commercial/latest/samples/index The exact solution to your question may have been answered before, please use the search on the homepage.

  • ABP Framework version: v4.0.1
  • UI type: MVC
  • DB provider: EF Core
  • Tiered (MVC) or Identity Server Seperated (Angular): no
  • Exception message and stack trace:
  • Steps to reproduce the issue:

<br> <br> My last question, regarding the Payment module, could have been avoided if you had proper documentation, including expected use-cases with sample code.  I am now planning on implementing the Blog Module and there is no documentation at all, just a TODO.  So what to do?  Well, I searched support and found another question about Blogs, posted recently, that included the fact that the blogs were at /blogs/{NAME} .  Ah, great, now I can go that page, create a new post, but I get the JS error below.

This is the only complaint that I have with ABP: The module documentation doesn't go far enough in depth.  Not even close.  Going back to the Payment module question that I posted previously, there were so many follow ups that I had to ask, and even then your architecture for that Module was not fully explained, so I gave up (until now!).

I know you are amazing developers and software architects.  That is why I paid for the commercial license, because your code is great and you obviously know what you are doing.  I have both managed and been a part of high end development teams, and I understand that we all would rather spend time working on new code than documenting what is there already, as of course it is 'easy to understand and makes sense' (because you / we wrote it!).

However the X amount of hours it might take your lead module developer to fully document a module, versus the 8000 total hours that it might save your customers should be a priority.  We pay for the commercial license because we can see a list of all these amazing features.  When we get to the point of implementation, check the docs and see a page of incomplete documentation, or worse, a TODO, and realise that now we need to invest hours / days of our time investigating your libraries and asking questions like this on your premium support then it makes us question the value of our purchase.

Also, we have a certain number of premium support tickets available per year.  These should be used to ask proper questions when we have significant issues where there is a bug / blocker type situation.  Having to spend our premium support tickets on basic questions that should be covered in documentation both frustrates you and us.

The rest of your documentation is quite good, especially the Web Application Development Tutorials.  I would ask that you provide the same level of documentation for your Modules as soon as possible.

Thanks,

Karim

 


1 Answer(s)
  • 0
    liangshiwei created
    Support Team

    Hi,

    For blog module problem: https://github.com/abpframework/abp/issues/6473#issuecomment-738703428

    We have written documentation for all commercial modules : ), and we will to improve the documentation of open source modules,they are already in the milestone. Thanks.

    About payment module document, see: https://docs.abp.io/en/commercial/latest/modules/payment