Looking for advice on improving documentation/community posts

Posted by jackyzheng on Tuesday August 29, 2017 @10:48PM
from the self-post dept.

Hey there guys, I'm currently doing my first internship, and just finished documenting my first project with AWS IoT.

The company I work for focuses on developing a security module for the Raspberry Pi that holds an embedded private key that cannot be read/exported and I did a write-up on how to use this key to authenticate with AWS IoT.

Just wanted to get some feedback on I can improve documentation/community posts. Since I've been so head deep in this project I just wanted some fresh perspectives, thanks!

Here's the link to my community post: https://community.zymbit.com/t/aws-iot-authentication-and-data-publishing-with-zymkey-4i-certificate/214

( 1 comment | 3 points | on HN )

Re:Looking for advice on improving documentation/community p... by chi17 on Tuesday August 29, 2017 @11:24PM (#15129505)

Create a group/organization for the project or company, and put the documentation in a project under that group/organization in GitHub, preferably along with the project, which preferably has an open-source license that's appropriate (Apache and MIT are popular, and be careful not to use a license just because it's sounds cool or irreverant- often they won't pass Legal): https://www.gnu.org/licenses/license-list.en.html

[ Parent | on HN ]