JBehave
  1. JBehave
  2. JBEHAVE-952

Documentation specifically for non-technical users of JBehave

    Details

    • Type: Improvement Improvement
    • Status: Open Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None
    • Number of attachments :
      0

      Description

      As it seems there is no documentation of JBehave for non-technical users.

      The documentation on www.jbehave.org is mixed with the technical and non-technical aspects of JBehave. This is not suitable for non-technical people learning to write JBehave stories.

      I suggest that a documentation is created specifically for non-technical users of JBehave. It should be as practical as possible, please no calculator examples or something like that. And it should contain some best practices for how to write JBehave stories.

        Activity

        Hide
        Mauro Talevi added a comment -

        Hi Otto, could you provide some example of what you consider non-technical documentation?

        Feel free to contribute one or more pages based on how you'd like to see it shaping up.

        http://jbehave.org/reference/stable/how-to-contribute.html

        Show
        Mauro Talevi added a comment - Hi Otto, could you provide some example of what you consider non-technical documentation? Feel free to contribute one or more pages based on how you'd like to see it shaping up. http://jbehave.org/reference/stable/how-to-contribute.html
        Hide
        Otto Diesel added a comment -

        In our company we have technical test automaters and non-technical testers. The testers are strong at business logic and test design, but very weak at technical stuff like programming.

        The JBehave documentation on www.jbehave.org seems to be written for people with programming skills or for the people who write the step implementations.

        It is hard for a tester with no programming skills to learn writing JBehave stories by using the documentation on www.jbehave.org since it is not written for people like him.

        We have to explain to testers how to write JBehave stories. It would be easier for us if we could tell them: "Read the tutorial on the JBehave site". But there is no such tutorial written for people like them (non-programmers).

        JBehave enables separation of coding and test design. There are teams where testers have no programming skills. They need a documentation about how to write stories which is written in such a way that they understand it easily.

        I am still a bit of a JBehave learner. But I am willing to contribute such a Wiki page or tutorial for non-programmers on how to write stories. As it seems I have to clone the repository, commit my proposals and link it to this issue.

        Show
        Otto Diesel added a comment - In our company we have technical test automaters and non-technical testers. The testers are strong at business logic and test design, but very weak at technical stuff like programming. The JBehave documentation on www.jbehave.org seems to be written for people with programming skills or for the people who write the step implementations. It is hard for a tester with no programming skills to learn writing JBehave stories by using the documentation on www.jbehave.org since it is not written for people like him. We have to explain to testers how to write JBehave stories. It would be easier for us if we could tell them: "Read the tutorial on the JBehave site". But there is no such tutorial written for people like them (non-programmers). JBehave enables separation of coding and test design. There are teams where testers have no programming skills. They need a documentation about how to write stories which is written in such a way that they understand it easily. I am still a bit of a JBehave learner. But I am willing to contribute such a Wiki page or tutorial for non-programmers on how to write stories. As it seems I have to clone the repository, commit my proposals and link it to this issue.
        Hide
        Otto Diesel added a comment -

        Where exactly in the repository is the documentation (JBehave Wiki pages)?

        Show
        Otto Diesel added a comment - Where exactly in the repository is the documentation (JBehave Wiki pages)?
        Show
        Tidhar K.O. added a comment - do you mean this: https://github.com/jbehave/jbehave-site/tree/master/site-frontend/src/site/content
        Hide
        Mauro Talevi added a comment -

        Yes you can use

        https://github.com/jbehave/jbehave-site/tree/master/site-frontend/src/site/content

        or

        https://github.com/jbehave/jbehave-core/tree/master/distribution/src/site/content

        depending on whether you want to make the doc core-specific or more generic - i.e. applicable to web too.

        In your case the jbehave-site would seem the best choice.

        Note that it's not a wiki. It's static html content.

        Show
        Mauro Talevi added a comment - Yes you can use https://github.com/jbehave/jbehave-site/tree/master/site-frontend/src/site/content or https://github.com/jbehave/jbehave-core/tree/master/distribution/src/site/content depending on whether you want to make the doc core-specific or more generic - i.e. applicable to web too. In your case the jbehave-site would seem the best choice. Note that it's not a wiki. It's static html content.
        Hide
        Otto Diesel added a comment -

        I looked at that more closely now. And it seems to be quite a overhead to me to contribute documentation for non-programmers on how to use JBehave/BDD.

        Originally I hoped someone else will do that of the JBehave community.

        If you set up a Wiki, then I would contribute that, but checking sources out of Github, writing HTML files and comitting them in order to contribute a documentation is too much overhead to me compared to write that information down in our company Wiki and discuss it with my colleages.

        I found some good doumentation for Cucumber (http://cukes.info/), including two books, where I will use that and try to apply it to JBehave.

        You can close this issue or delete it if you like.

        Show
        Otto Diesel added a comment - I looked at that more closely now. And it seems to be quite a overhead to me to contribute documentation for non-programmers on how to use JBehave/BDD. Originally I hoped someone else will do that of the JBehave community. If you set up a Wiki, then I would contribute that, but checking sources out of Github, writing HTML files and comitting them in order to contribute a documentation is too much overhead to me compared to write that information down in our company Wiki and discuss it with my colleages. I found some good doumentation for Cucumber ( http://cukes.info/ ), including two books, where I will use that and try to apply it to JBehave. You can close this issue or delete it if you like.

          People

          • Assignee:
            Unassigned
            Reporter:
            Otto Diesel
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:

              Time Tracking

              Estimated:
              Original Estimate - 2 days
              2d
              Remaining:
              Remaining Estimate - 2 days
              2d
              Logged:
              Time Spent - Not Specified
              Not Specified