Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.0 M3
    • Fix Version/s: 1.0 RC1
    • Component/s: Documentation
    • Labels:
      None

      Description

      From the forum (http://forum.springframework.org/showthread.php?t=34800):

      1) Remove or reduce the emphasis on Marketing overhead.
      For example in the "Spring-WS is meant for Public Web Services", it appears most of the text is spent defending/justifying a very small but important point about contract-first design. The title leads one to the question about "What if my application will never be public - is Spring not designed for me.
      As an architect/programmer, I really only need to know 2 things in this whole section
      a) Spring-WS is good for both Public and private applications
      b) It is a good idea to specify the messages without regard to implementation.

      Another Example
      In "Spring-WS is Data-Driven", 8 paragraphs are written before Spring is mentioned once. All of these 8 paragraphs have nothing to do with Spring and are only there to criticize some other unnamed architecture.
      Put the last line first and write something about Spring being data-driven, I am not sure how this helps me use Spring-WS. The current info included there is of no use to me at all. It belongs in the marketing brochure not a reference manual.

      Another Example
      Spring-WS Focuses on Contract-first Development (spelling in "focusses" in original)
      This is minor but the same philosophy. It starts of with a useful sentence and then talks about the problems with a possible non-Spring-WS approach before it gets back to how Spring-WS does it.
      The whole section is pure marketing. It would be much better if the first sentence was followed by the statement that Spring is contract-first.
      AND THEN an explanation about what you mean by that and how that shapes the Spring-WS programming flow, ie, create the message definition which is used to create the WDSL file and so one.
      If you really feel that you must, add a sentence or two about how this helps the Spring developer (not about some other approach not being as good).

      2) In the Holiday example, it would be helpful to show in the WDSL, a response confirmation message to the holiday request even if the whole process about developing it is not shown in the same detail asthe request.

      3) In the last line of Chapter 2, the author promises
      "This is the final WSDL. We will describe how to implement the resulting schema and WSDL in the next chapter."
      As nearly as I can tell, this never happens. The next chapter is about security.

        Activity

        Hide
        arjen.poutsma Arjen Poutsma added a comment -

        I've replaced the section with a "What is Spring-WS" section, which goes more into the specific features of SWS.

        Show
        arjen.poutsma Arjen Poutsma added a comment - I've replaced the section with a "What is Spring-WS" section, which goes more into the specific features of SWS.
        Hide
        arjen.poutsma Arjen Poutsma added a comment -

        Closing RC1 issues.

        Show
        arjen.poutsma Arjen Poutsma added a comment - Closing RC1 issues.

          People

          • Assignee:
            arjen.poutsma Arjen Poutsma
            Reporter:
            arjen.poutsma Arjen Poutsma
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: