Documentation Without Frustration

Documentation without Frustration (DWF)

_images/books.png

… or how to get a software developer to write documentation.

Written for software developers, software team leads and everybody who hates writing docs.

Press S to open speaker notes view or ESC for slides overview.
Presentation can be freely used, forked and changed for meetups and co.
_images/creative_common.png
_images/documentation_diagram.png

What will be discussed...

What belongs to “Documentation”

Why writing documentation frustrates us

What is needed to keep motivation high enough

How Sphinx and PlantUML supports developers

Which Cloud Services save a lot of time

What belongs to documentation?

Nearly anything you can imagine

_images/documentations.png

… and much more.

What tools needs to be used for docs?

Nearly anything you can imagine

_images/documentations_tools.png

… and much more.

Potential of Frustration

Team Setup Example

_images/team.png

Frontend - Backend - Infrastructure

Each developer is responsible for the complete documentation of his/her domain.

Potential of Frustration

1/2

For each document type you may need a different tool
Frustration: Tool-KnowHow needed
Frustration: Context/tool switches during development

Most tools forces you to somehow “style” your information
Frustration: Spend time for not functional nor informative work

Potential of Frustration

2/2

No synchronisation with existing code
Frustration: Maintain same code / information at different locations

No common storage, versioning or release for documentations and code
Frustration: Nothing is in sync

Motivation Boosters

KISS

_images/code_ide.png

IDEs integrate different kinds of inputs to create multiple outputs

KISS = Keep It Short and Simple

Motivation Boosters

Documentation = Code

Same requirements for code and documentation

  • Editable inside IDE (text, images, diagrams, everything!)
  • Text based files
  • Stored and version-controlled beside the code
  • Deeply linked with code (e.g. reuse of docstrings)
  • Focused on information and not on layout or design
  • Supports continuous integration / deployment

Example

My code document
================

This little piece of text describes the function
:ref:`my_package.my_module.my_class.my_func`.

Docstring
---------

.. autofunction:: my_package.my_module.my_class.my_func

Inheritance diagram
-------------------

.. inheritance-diagram:: my_package.my_module.my_class

Code example
------------

You can use the function like this::

    test_class = MyClass()
    return_value = test_class.my_func(some_data)

Sphinx

Documentation generator

Takes text and code files, generates …

_images/sphinx_workflow.png

Sphinx, based on docutils and restructuredText

Projects using Sphinx

Python Sphinx Linux Blender Ethereum
_images/sphinx_project_python.png _images/sphinx_project_sphinx.png _images/sphinx_project_linux.png _images/sphinx_project_blender.png _images/sphinx_project_ethereum.png

readthedocs.io : ~54k projects and ~65k users (2016)

pypi.org : ~250 extensions & themes for sphinx (2017)

Sphinx Basics

1/4

Sphinx Basics
=============

Text styles
------------
**bold text**  *italic text*  ``code sample``

Links
-----
http://dwf.rtfd.io

`Documentation without frustration <http://dwf.rtfd.io>`_
Sphinx documentation: reStructuredText Primer

Sphinx Basics

2/4

Unsorted list
=============

* Item 1
* Item 2

    * Item 2.1

* Item 2

Sorted list
===========

#. Item 1
#. Item 2
Sphinx documentation: reStructuredText Primer

Sphinx Basics

3/4

Images
======

.. image:: my_image.png
   :scale: 50%

Tables
======

=====  =====  =======
A      B      A and B
=====  =====  =======
False  False  False
True   False  False
False  True   False
True   True   True
=====  =====  =======
Sphinx documentation: reStructuredText Primer

Sphinx Basics

4/4

Source Code
===========
Just use two of it::

    def func(me):
        return me

Or for more details:

.. code-block:: python
    :linenos:
    :emphasize-lines: 1,3

    def func(a, b):
        c = a + b
        return c
Sphinx documentation: Showing code examples

Working with existing code

1/5

Reuse existing code

.. literalinclude::  slides/sphinx_code.rst
    :language: rst
    :lines: 3-10
    :linenos:
1
2
3
4
5
6
7
8
    .. revealjs:: Working with existing code
        :subtitle: 1/5

        Reuse existing code

        .. rv_code::

            .. literalinclude::  slides/sphinx_code.rst
Sphinx documentation: Showing code examples

Working with existing code

2/5

Automated code documentation

.. autofunction:: os.path.join
os.path.join(a, *p)

Join two or more pathname components, inserting ‘/’ as needed. If any component is an absolute path, all previous path components will be discarded. An empty last part will result in a path that ends with a separator.

Sphinx documentation: Include documentation from docstrings

Working with existing code

3/5

Inheritance diagrams

.. inheritance-diagram:: dwf.Dwf
Inheritance diagram of dwf.Dwf

Used code (examples/dwf/dwf.py):

class Tool: pass
class Documentation(Tool): pass
class Frustration(Tool): pass
class Dwf(Documentation, Frustration, Tool): pass
Sphinx documentation: Include inheritance diagrams

Working with existing code

4/5

Documenting program output

.. command-output:: python -V
$ python -V
Python 3.5.2
Sphinx documentation: sphinxcontrib.programoutput

Working with existing code

5/5

Documenting database models

.. sadisplay::
    :module: dwf_db
_images/sphinx_database.png

Sphinx documentation: sphinxcontrib-sadisplay

Standalone tool: sadisplay

PlantUML

Tool: PlantUML

Sphinx documentation: sphinx-plantuml

PlantUML

Class diagrams - Result

_images/plantuml_class.png

PlantUML

Class diagrams - Code

@startuml
    class user {
        name
        age
        email
        check_password()
        send_email(message)
    }

    class domain
    class group
    class api_key
    class permission

    user --> domain
    user --> group
    user --> api_key
    user --> permission: 1:n
    group --> permission: 1:n
@enduml
PlantUML documentation: Class diagram

PlantUML

Sequence diagrams - Result

_images/plantuml_sequence.png

PlantUML

Sequence diagrams - Code

@startuml
    user --> server : send request
    server --> server: check request
    server --> database: ask for data
    database --> server: provide data
    server --> server: render data
    server --> user: send rendered data
@enduml
PlantUML documentation: Sequence diagram

PlantUML

PyCharm Integration

_images/pycharm_plantuml.png Plugin: IntelliJ PlantUML Integration

Sphinx-Needs

Extension to manage requirements, specifications or test cases

Can be configured to support other types. Like user stories, bugs, servers, …

Developed to support ISO 26262 inside Sphinx

Sphinx Documentation: Sphinx-needs

Sphinx-Needs

Need-Objects Code

.. story:: As user I want to be able to use my email address for login
   :id: US_001
   :tags: user; login; email, security

   We need to use the unique email address for user login and verification

   .. uml::

        object Alice
        object Bob
        Alice --> Bob

.. spec:: Use flask-login for secure user verification and authorisation
    :tags: user, security
    :id: SP_001
    :link: US_001
Sphinx-Needs documentation: need/ req (or any other defined need type)

Sphinx-Needs

Need-Objects Result

User Story: As user I want to be able to use my email address for login US_001
tags: user login email security
links incoming: SP_001 IMP_SP_001
links outgoing: None

We need to use the unique email address for user login and verification

_images/needs_alice_bob..png
Specification: Use flask-login for secure user verification and authorisation SP_001
tags: user security
links incoming: None
links outgoing: US_001

Sphinx-Needs

Need-Objects Filtering

As list

.. needfilter::
    :tags: security
Sphinx-Needs documentation: needfilter

Sphinx-Needs

Need-Objects Filtering with complex filter

As table

.. needfilter::
    :filter: id == "US_001" or "security" in tags
    :layout: table
ID Title Type Status Links Tags
SP_001 Use flask-login for secure user verification and authorisation Specification   US_001 user; security
US_001 As user I want to be able to use my email address for login User Story   user; login; email; security

Sphinx-Needs

Need-Objects Filtering with regex

As diagram

.. needfilter::
    :filter: search("\w{5,}", title) and "security" in tags  # word with at least 5 chars inside title
    :layout: diagram
_images/need_diagram_filter.png

Sphinx-Needs

Export

make needs
# File: _build/needs/needs.json
{
    "created": "2017-09-21T20:40:49.090464",
    "current_version": "1.0",
    "project": "Documentation without Frustration",
    "versions": {
        "1.0": {
            "created": "2017-09-21T20:40:49.090443",
            "needs": {
                "SP_001": {
                    "description": "",
                    "id": "SP_001",
                    "links": [
                        "US_001"
                    ],
                    "status": null,
                    "tags": [
                        "user"
                    ],
                    "title": "Use flask-login for secure user verification and authorisation",
                    "type": "spec",
                    "type_name": "Specification"
                },
                "US_001": {
                    "description": "We need to use the unique email address for user login and verification\n\n.. uml::\n\n         @startuml\n         rectangle Alice\n         rectangle Bob\n         Alice -right-> Bob\n         @enduml",
                    "id": "US_001",
                    "links": [],
                    "status": null,
                    "tags": [
                        "user",
                        "login",
                        "email"
                    ],
                    "title": "As user I want to be able to use my email address for login",
                    "type": "story",
                    "type_name": "User Story"
                }
            },
            "needs_amount": 2
        }
    }
}
Sphinx-Needs documentation: Builders

Sphinx-Needs

Import

.. needimport:: needs.json
   :id_prefix: imp_
   :version: 1.0
   :tags: imported
   :filter: "UST" in id
Specification: Use flask-login for secure user verification and authorisation IMP_SP_001
tags: user imported
links incoming: None
links outgoing: US_001
Sphinx-Needs documentation: needimport

Cloud Services

_images/cloud.png

Cloud Services

GitHub

  • Store code and files with git
  • Get issue tracker, wiki, website and more
  • Automatically interacts with hundreds of other web services
  • Free for open-source projects

Link: github.com

Cloud Services

Read the docs

  • Builds, deploys and hosts sphinx documentations
  • Gets triggered by changes on github
  • Free for open-source projects

Link: readthedocs.org

Cloud Services

Travis

  • Continuous Integration system
  • Builds, tests and deploys nearly everything
  • Gets triggered by changes on github
  • Free for open-source projects

Link: travis-ci.org

Thanks for your attention ...

… and see you on DWF’s issue tracker :)

github github.com/useblocks/dwf
This presentation dwf.readthedocs.io

Maintainer

Daniel Woste

_images/daniel_woste.png _images/useblocks_logo.png

LICENSE

Presentation and Documentation
==============================

Creative Common 4.0 International

https://creativecommons.org/licenses/by/4.0/legalcode

Copyright (c) 2016-2017 useblocks GmbH

Creative Commons Attribution 4.0 International Public License

By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.

Section 1 – Definitions.

Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
Licensor means the individual(s) or entity(ies) granting rights under this Public License.
Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
Section 2 – Scope.

License grant.
Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
reproduce and Share the Licensed Material, in whole or in part; and
produce, reproduce, and Share Adapted Material.
Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
Term. The term of this Public License is specified in Section 6(a).
Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
Downstream recipients.
Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
Other rights.

Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
Patent and trademark rights are not licensed under this Public License.
To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
Section 3 – License Conditions.

Your exercise of the Licensed Rights is expressly made subject to the following conditions.

Attribution.

If You Share the Licensed Material (including in modified form), You must:

retain the following if it is supplied by the Licensor with the Licensed Material:
identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
a copyright notice;
a notice that refers to this Public License;
a notice that refers to the disclaimer of warranties;
a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
Section 4 – Sui Generis Database Rights.

Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:

for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
Section 5 – Disclaimer of Warranties and Limitation of Liability.

Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
Section 6 – Term and Termination.

This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:

automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
Section 7 – Other Terms and Conditions.

The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
Section 8 – Interpretation.

For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.

Software
========

MIT License

Copyright (c) 2016-2017 useblocks GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.