Skip to main content

Subject oriented linking within apps and websites works great in techcomm, too. See A List Apart @sophiavux -


Quill - Editing Posts via Mail

1 min read

Quill Editor

By means of the IndieWeb Editor Quill by Aaron Parecki it is possible to write posts via e-mail.

As a prerequisite you need a twitter account for reasons of authentification. And furthermore you need to have enabled the plugin IndiePub in Known.

This e-mail I wrote:

Mailing to Known


1) Go to

2) Enter your domain. Mine is e.g.

3) Click Authorize.

Quill Authorization

4)  Choose an authentification provider

Quill Authentification provider

5) Click Continue

6) Click on Email and note your new email address given by Quill.

Button  Email

7) Write your email and send it to your Quill email address. Enjoy your new post at your withknown site. This was my resulting post.


Documentation will never be part of the culture

1 min read

until it is part of the code and workflow. Luke Gaudreau has taken notes during the presentation of Riona MacNamara at Write The Docs in May 2015.

 She had talked to engineers

  • bad, missing, wrong docs
  • no time, no incentive, no culture

• documentation will never be part of the culture untils its part of the code and workflow

• use markdown, next to code, render it at a logical URL

• g3doc: radically simple documentation

• culture

  • open, transparent, generous
  • contributor governance

• strong recommendations from teams, significant support from senior staff

• change goals

  • stable, reliable platform
  • make it the best doc platform
  • be the best team

• focus on the engineer

  • can’t expect engineers to adapt their workflow

• momentum matters

  • start small, iterate often

See the lecture on video



Embedding a github gist as a whole blogpost into blogging cms works great - @withknown


Halten Sie Ihre Onlinehilfe durch ein Linkkonzept und indirektem Verlinken modular.


Bookmark: Convert CSV-data to XML-files

Here’s a tool The Techwriting Engineer developed that transforms CSV-data into XML-data based on a template.

How it works.


Mysterious DITA-OT but still loving it. Only YES in uppercase with task labels (property name="args.gen.task.lbl" value="YES"/)


Unterversorgte Dokumentation?

1 min read

Technical Writing


Überall im Netz wird von Technischen Redakteuren die mangelnde Unterstützung für eine professionellere Dokumentation beklagt. Wieso sollten jedoch trotz Unternehmensgewinns Ausgaben in die Technische Dokumentation fließen?

So lange es Technischen Redakteuren nicht gelingt, den Vorzug eines Investments in die Dokumentation zu belegen, wird sich im Unternehmen nichts ändern, denn Geschäftsführungen sind dem gesamten Unternehmen gegenüber verpflichtet. Natürlich sollen Redakteure weiterhin für eine hilfreiche Dokumentation einstehen. Es gibt im Unternehmen jedoch weitere Betätigungsfelder, die eigentlich nur sie besetzen können. Das Buch hält Vorschläge an Redakteure und Geschäftsführer bereit

Als eBook veröffentlicht am 30. Mai 2011. Unterversorgte Dokumentation? von Andreas Petersell steht unter einer Creative Commons Namensnennung 3.0 Deutschland Lizenz.


als EPUB und PDF möglich unter


Sie finden das Buch online unter  Seminarwork.


Writing Use Cases in DITA XML for a faster software documentation.