Lorna Mitchell

Developer Advocate

Vonage

Lorna is based in Yorkshire; she is a Developer Advocate with Nexmo as well as a published author and experienced conference speaker.

She brings her technical expertise on a range of topics to audiences all over the world with her writing and speaking engagements, always delivered with a very practical slant.

In her spare time, Lorna blogs at lornajane.net.

GitHub is your Documentation Landing Page

Having a good README file in every GitHub project is a key ingredient of good developer experience, but what makes a good README?

This session looks at the various types of projects you might want to create a README for, and offers examples of good README practice in each case. Making sure the purpose and status of the project is key, and directing users to your (beautiful and actively maintained) main documentation is definitely part of the deal. But we can do more to engage and inform developers that reach our projects this way, and this session will show you how.

Recommended for everyone who wants to make the projects we create a welcoming place for users, however they find us.

Links

Blog: lornajane.net

Twitter: lornajane

DevRelCon is brought to you by Hoopy.

Talk to us about developer relations training, strategy, research, and execution support for your team.

hoopy.io

[email protected]