Skip to main content
 

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

Procedure

1) Go to https://quill.p3k.io/

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

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 - http://bit.ly/1OrN4Of @withknown

 
 

Halten Sie Ihre Onlinehilfe durch ein Linkkonzept und indirektem Verlinken modular. http://bit.ly/1KrRh1A

 

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"/)

 

Connecting Known with Instagram 1 - Ownyourgram.com

1 min read

Connection your Known Site with Instagram

Connecting your Known Site with Instagram works just the other way round than usual. You link your Instagram Site to Known by exporting Instragram photos to Known via OwnYourGram.com.

It is a kind of prerequisite that you have a twitter account for reasons of authentification.

These steps must be performed.

  1. Set up an Instagram Account and a Twitter Account
  2. Connect your Instagram Account with Ownyourgram.com
  3. Connect your Instagram Account with Brid.gy
  4. Adapt your Known plugin IndiePup the way Kyle Mahan suggested
  5. Enjoy your photos and likes on your Known Site as well

Step 2 - Since it was fairly simple to connect my Instagram account with Ownyourgram.com I let screenshots speak. Just go to ownyourgram.com and start.

1)

ownyourgram 1

2)

ownyourgram 2

3)

ownyourgram

4)

ownyourgram 4

5)

ownyourgram 5

6) Click Continue

7)

ownyourgram 7

8)

ownyourgram 8

9)

ownyourgram 10

10)

ownyourgram 11

11)

ownyourgram 12 - result in known site

 

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.

Download

als EPUB und PDF möglich unter github.com.

Online

Sie finden das Buch online unter  Seminarwork.

 

It took me seconds to connect with twitter and days with facebook

2 min read

CMS Known

 

Finally I have made it to connect my self hosted Known site with facebook. But unfortunately it took me 2 days. Whereas connecting to Twitter and Flickr took me just a few seconds. What went wrong?

After logging in as so called Faceook Developer my app remained in developement mode. Or in other words: it is not live yet. What could I do?

Facebook developement mode 

I clicked the Getting Started button, of course. And I was very hardworking. I wrote a description, an explanation for permission (I would like to autopost articles from my site to my facebook profile.), I uploaded 4 screenshots out from Known, copied a privacy policy and finally I even made an app icon. I was proud and felt a bit like a student about to graduate.

After 2 days the certificate of my failure came, dressed in red. You do not need to submit any items for approving at all!

Facebook Developer Failure

OK, I asked my friend Google. And even real developers had the same problem: http://stackoverflow.com/questions/21329250/the-developers-of-this-app-have-not-set-up-this-app-properly-for-facebook-login.

All I missed was to add a so called Contact Mailaddress in the Settings. It was neither a mandatory fieled nor was there any hint to fill all fields in this tab after submitting. And now they want to know about my app review experience? Unique. Hey, it´s Facebook where all my friends are who do not know what I am doing.

P.S. Don´t forget to visit the Brigdy website to authenticate for facebook.
http://www.petersell.com/tag/technicalwriting?offset=10
www.petersell.com
crawl=CC-MAIN-2017-47
59014
application/http; msgtype=response
sha1:SOLQOGTWUSPZMKT7ENW3CWU7XP7CJH2V
<urn:uuid:061da787-c2f8-48bb-94af-2fe6fd8617a6>
2017-11-19T15:59:47Z
89.107.184.10
text/html
sha1:CAW3JNFIGL6WUO2AP3MG2NPLXJ6YVIX2
<urn:uuid:89180597-ae53-414f-a69d-37573d17a4cb>
http://www.petersell.com/tag/technicalwriting?offset=10
response
<urn:uuid:0d3278ad-6591-486d-b822-66f0c02623db>
robots: classic
hostname: ip-10-67-196-54.ec2.internal
software: Nutch 1.6 (CC)
isPartOf: CC-MAIN-2017-47
operator: Common Crawl Admin
description: Wide crawl of the web for November 2017
publisher: Common Crawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf