)]}'
{"doc/contributor-guide/source/topic-structure.rst":[{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"4c5ebc7e2f58939656af29445d9b4caf85014699","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":1,"id":"ba15a1d1_35c5bc8d","updated":"2015-09-14 20:55:43.000000000","message":"REading the content, I wonder whether Topic-based is another word for  \"every page is page one\". What\u0027s the relation between them?","commit_id":"7085cc6ef7fa8dfd92c21b7320b6e031ecc234e9"},{"author":{"_account_id":17626,"name":"Svetlana Karslioglu","email":"skarslioglu@mirantis.com","username":"svekars"},"change_message_id":"7bd5e829708ab3c720085164804e5ae350f03e06","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":1,"id":"ba15a1d1_755a5485","in_reply_to":"ba15a1d1_35c5bc8d","updated":"2015-09-14 21:14:03.000000000","message":"Andreas, if you are referring to the book of Mark Baker, then yes this is the same approach. In fact the book title says: Every Page is Page One: Topic-based Writing for Technical Communication and the Web.\nThough, I\u0027m more used to the term topic-based writing.","commit_id":"7085cc6ef7fa8dfd92c21b7320b6e031ecc234e9"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"4c5ebc7e2f58939656af29445d9b4caf85014699","unresolved":false,"context_lines":[{"line_number":2,"context_line":".. _topic_structure:"},{"line_number":3,"context_line":""},{"line_number":4,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":5,"context_line":"Topic Structure"},{"line_number":6,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":7,"context_line":""},{"line_number":8,"context_line":"Organize technical information in topics.Use the principles of topic-based"}],"source_content_type":"text/x-rst","patch_set":1,"id":"ba15a1d1_75ca54a3","line":5,"updated":"2015-09-14 20:55:43.000000000","message":"structure is lowercase - we use sentence style capitalization","commit_id":"7085cc6ef7fa8dfd92c21b7320b6e031ecc234e9"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"4c5ebc7e2f58939656af29445d9b4caf85014699","unresolved":false,"context_lines":[{"line_number":5,"context_line":"Topic Structure"},{"line_number":6,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":7,"context_line":""},{"line_number":8,"context_line":"Organize technical information in topics.Use the principles of topic-based"},{"line_number":9,"context_line":"authoring in all technical publications."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"Topic-based authoring is an approach to the content creation where"}],"source_content_type":"text/x-rst","patch_set":1,"id":"ba15a1d1_75f3340b","line":8,"updated":"2015-09-14 20:55:43.000000000","message":"Add space after \".\"","commit_id":"7085cc6ef7fa8dfd92c21b7320b6e031ecc234e9"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"4c5ebc7e2f58939656af29445d9b4caf85014699","unresolved":false,"context_lines":[{"line_number":20,"context_line":""},{"line_number":21,"context_line":"Structure the information around the following topics:"},{"line_number":22,"context_line":""},{"line_number":23,"context_line":"* **Concept**"},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"  A concept topic explains a particular functionality. A concept"},{"line_number":26,"context_line":"  topic does not provide a sequence of steps or information on how to use the"}],"source_content_type":"text/x-rst","patch_set":1,"id":"ba15a1d1_750fb4e1","line":23,"updated":"2015-09-14 20:55:43.000000000","message":"Use a definition list instead of an enumeration - or don\u0027t make the entries bold","commit_id":"7085cc6ef7fa8dfd92c21b7320b6e031ecc234e9"},{"author":{"_account_id":17096,"name":"Aditi Rajagopal","email":"arajagopal@us.ibm.com","username":"aditirajagopal"},"change_message_id":"b69c93784facbc0617206f7fbb98411a7c9029b7","unresolved":false,"context_lines":[{"line_number":46,"context_line":"   a sequence of steps on how to achieve the goal of the task. A section"},{"line_number":47,"context_line":"   (or chapter) is the high level task topic."},{"line_number":48,"context_line":""},{"line_number":49,"context_line":"   Typically, a section includes multiple sub- task, concept, and reference"},{"line_number":50,"context_line":"   topics. Start the title of a high level task topic with a verb in gerund and"},{"line_number":51,"context_line":"   the title of a sub task topics with a verb in imperative."},{"line_number":52,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"ba15a1d1_808328cc","line":49,"updated":"2015-09-14 21:36:40.000000000","message":"Not sure what you mean here....are you trying to say \n\n\"Typically, a section includes multiple sub-sections: tasks, concepts, and reference topics\"\n\nOR\n\n\"Typically, a section includes multiple sub-tasks, concepts, and reference topics\"","commit_id":"001eb97fde39f418d91702ee9a0bfcbb9f396157"},{"author":{"_account_id":17626,"name":"Svetlana Karslioglu","email":"skarslioglu@mirantis.com","username":"svekars"},"change_message_id":"eee589974ecaaf2a0d0228fdff2bb3203a07a0db","unresolved":false,"context_lines":[{"line_number":46,"context_line":"   a sequence of steps on how to achieve the goal of the task. A section"},{"line_number":47,"context_line":"   (or chapter) is the high level task topic."},{"line_number":48,"context_line":""},{"line_number":49,"context_line":"   Typically, a section includes multiple sub- task, concept, and reference"},{"line_number":50,"context_line":"   topics. Start the title of a high level task topic with a verb in gerund and"},{"line_number":51,"context_line":"   the title of a sub task topics with a verb in imperative."},{"line_number":52,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"ba15a1d1_a374339c","line":49,"in_reply_to":"ba15a1d1_808328cc","updated":"2015-09-14 23:43:15.000000000","message":"Thank you, Aditi! I addressed this one!","commit_id":"001eb97fde39f418d91702ee9a0bfcbb9f396157"},{"author":{"_account_id":14962,"name":"ologvinova","email":"ologvinova@mirantis.com","username":"ologvinova"},"change_message_id":"758d34fd83e140baffab982687596f90f12bcc66","unresolved":false,"context_lines":[{"line_number":20,"context_line":"information. Each topic states prerequisites and dependencies, if any, as"},{"line_number":21,"context_line":"well as provides information about the next steps."},{"line_number":22,"context_line":""},{"line_number":23,"context_line":"In topic-based authoring a chunk of information is called `topic`."},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"Structure the information around the following topics:"},{"line_number":26,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a8ffd7b_beedd2b8","line":23,"updated":"2015-12-02 11:04:29.000000000","message":"Comma after \u0027authoring\u0027.","commit_id":"7467f09e006b76ad560530f18d5a0f15ca5a9a39"},{"author":{"_account_id":14962,"name":"ologvinova","email":"ologvinova@mirantis.com","username":"ologvinova"},"change_message_id":"758d34fd83e140baffab982687596f90f12bcc66","unresolved":false,"context_lines":[{"line_number":42,"context_line":"   * Title"},{"line_number":43,"context_line":"   * Description"},{"line_number":44,"context_line":"   * Related links"},{"line_number":45,"context_line":"   * (optional)Diagrams"},{"line_number":46,"context_line":"   * (optional)Examples"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"* Task"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a8ffd7b_176e41c9","line":45,"updated":"2015-12-02 11:04:29.000000000","message":"A space is missing after second parenthesis.","commit_id":"7467f09e006b76ad560530f18d5a0f15ca5a9a39"},{"author":{"_account_id":14962,"name":"ologvinova","email":"ologvinova@mirantis.com","username":"ologvinova"},"change_message_id":"758d34fd83e140baffab982687596f90f12bcc66","unresolved":false,"context_lines":[{"line_number":43,"context_line":"   * Description"},{"line_number":44,"context_line":"   * Related links"},{"line_number":45,"context_line":"   * (optional)Diagrams"},{"line_number":46,"context_line":"   * (optional)Examples"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"* Task"},{"line_number":49,"context_line":"   A task topic explains how to complete a particular task and provides"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a8ffd7b_f7637ddb","line":46,"updated":"2015-12-02 11:04:29.000000000","message":"likewise","commit_id":"7467f09e006b76ad560530f18d5a0f15ca5a9a39"},{"author":{"_account_id":14962,"name":"ologvinova","email":"ologvinova@mirantis.com","username":"ologvinova"},"change_message_id":"758d34fd83e140baffab982687596f90f12bcc66","unresolved":false,"context_lines":[{"line_number":52,"context_line":""},{"line_number":53,"context_line":"   Typically, a section includes multiple sub-sections: task, concept, and"},{"line_number":54,"context_line":"   reference topics. Start the title of a high level task topic with a verb"},{"line_number":55,"context_line":"   in gerund and the title of a sub task topics with a verb in imperative."},{"line_number":56,"context_line":""},{"line_number":57,"context_line":"   Task topics are the most important topics in any technical documentation."},{"line_number":58,"context_line":"   Typically, the reader browses through the table of contents searching for"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a8ffd7b_976c719d","line":55,"updated":"2015-12-02 11:04:29.000000000","message":"sub task -\u003e  subtask","commit_id":"7467f09e006b76ad560530f18d5a0f15ca5a9a39"},{"author":{"_account_id":14962,"name":"ologvinova","email":"ologvinova@mirantis.com","username":"ologvinova"},"change_message_id":"758d34fd83e140baffab982687596f90f12bcc66","unresolved":false,"context_lines":[{"line_number":64,"context_line":"   +--------------------------+---------------------------+"},{"line_number":65,"context_line":"   | **Section title**        | Monitoring performance    |"},{"line_number":66,"context_line":"   +--------------------------+---------------------------+"},{"line_number":67,"context_line":"   | **Task topic title**     | Delete a node, Recover    |"},{"line_number":68,"context_line":"   |                          | from a failure            |"},{"line_number":69,"context_line":"   +--------------------------+---------------------------+"},{"line_number":70,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a8ffd7b_9776b13c","line":67,"updated":"2015-12-02 11:04:29.000000000","message":"Start the 2nd example from the new line (bc now it looks like a part of the 1st title).","commit_id":"7467f09e006b76ad560530f18d5a0f15ca5a9a39"},{"author":{"_account_id":14962,"name":"ologvinova","email":"ologvinova@mirantis.com","username":"ologvinova"},"change_message_id":"758d34fd83e140baffab982687596f90f12bcc66","unresolved":false,"context_lines":[{"line_number":75,"context_line":"   * Procedure (a sequence of steps)"},{"line_number":76,"context_line":"   * Result"},{"line_number":77,"context_line":"   * Related links (See also)"},{"line_number":78,"context_line":"   * (optional)Examples"},{"line_number":79,"context_line":""},{"line_number":80,"context_line":"* Reference"},{"line_number":81,"context_line":"   A reference topic provides additional information about a functionality."}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a8ffd7b_3738253d","line":78,"updated":"2015-12-02 11:04:29.000000000","message":"A space is missing after second parenthesis.","commit_id":"7467f09e006b76ad560530f18d5a0f15ca5a9a39"}]}
