Tweet
Tweet

Slide 1

Slide 1 text

No content

Slide 2

Slide 2 text

Wasted

Slide 3

Slide 3 text

Bad Documentation

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

Missed Deadline

Slide 7

Slide 7 text

$8,000

Slide 8

Slide 8 text

$80,000

Slide 9

Slide 9 text

Trust

Slide 10

Slide 10 text

The process is broken

Slide 11

Slide 11 text

1. Write code

Slide 12

Slide 12 text

2. Open browser

Slide 13

Slide 13 text

3. Login to documentation site

Slide 14

Slide 14 text

4. Start writing docs

Slide 15

Slide 15 text

5. Fight with your editor

Slide 16

Slide 16 text

6.

Slide 17

Slide 17 text

7. Publish it

Slide 18

Slide 18 text

8. Keep it up to date

Slide 19

Slide 19 text

For. Every. Version.

Slide 20

Slide 20 text

The Right Way

Slide 21

Slide 21 text

1. Write Code

Slide 22

Slide 22 text

2. Write Docs

Slide 23

Slide 23 text

We do the rest

Slide 24

Slide 24 text

No content

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

.. _setup: ! Installation ============ ! phpMyAdmin does not apply any special security methods to the MySQL database server. It is still the system administrator's job to grant permissions on the MySQL databases properly. phpMyAdmin's :guilabel:`Users` page can be used for this. ! .. warning:: ! :term:`Mac` users should note that if you are on a version before :term:`Mac OS X`, StuffIt unstuffs with :term:`Mac` formats. So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts before uploading them to your server, as PHP seems not to like :term:`Mac`-style end of lines character ("``\r``"). ! Linux distributions +++++++++++++++++++ ! phpMyAdmin is included in most Linux distributions. It is recommended

Slide 27

Slide 27 text

No content

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

ReadtheDocs.org github.com/rtfd/readthedocs.org

Slide 30

Slide 30 text

No content

Slide 31

Slide 31 text

-15,000 open source projects -2.5M unique users a month

Slide 32

Slide 32 text

No content

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

No content

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

No content

Slide 37

Slide 37 text

blog.mozilla.org/webdev/2011/07/22/lets-‐write-‐some-‐docs/

Slide 38

Slide 38 text

Writing documentation started to pay off. Our results were immediately visible, and documentation became a priority. Dave Dash Senior Developer

Slide 39

Slide 39 text

ReadtheDocs.org for open source

Slide 40

Slide 40 text

Our mission is to elevate documentation to the same level as code

Slide 41

Slide 41 text

ReadtheDocs.com for private code

Slide 42

Slide 42 text

Control access to your docs

Slide 43

Slide 43 text

Understand how your docs are used

Slide 44

Slide 44 text

Require docs before features go live

Slide 45

Slide 45 text

Keep all your docs in one place

Slide 46

Slide 46 text

Ready to help you create great documentation

Slide 47

Slide 47 text

Team Over 10 years of Documentation Experience Eric Holscher Anthony Johnson

Slide 48

Slide 48 text

Documentation is now a solved problem for your business

Slide 49

Slide 49 text

Open Source docs at readthedocs.org

Slide 50

Slide 50 text

Private docs at readthedocs.com

Slide 51

Slide 51 text

docs.piepdx.com

Slide 52

Slide 52 text

Private beta at readthedocs.com

Slide 53

Slide 53 text

Join us in improving documentation joinus@readthedocs.com