Redesign the Documentation

[hacktivist123]

The Webpage looks too abstract it should be redesigned

[quozl]

I've had another look at https://developer.sugarlabs.org/ and don't know what you mean by being too abstract; could you tell us more?

[hacktivist123]

Its too simple, it needs some kind of colour enhancement and brilliant navigation scheme, i will send a redesign soon. i am working on it.

On 31 December 2017 at 23:13, James Cameron notifications@github.com wrote:

I've had another look at https://developer.sugarlabs.org/ and don't know what you mean by being too abstract; could you tell us more?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/sugarlabs/sugar-docs/issues/129#issuecomment-354625863, or mute the thread https://github.com/notifications/unsubscribe-auth/AZV4a2zIAmPw0cWY5kRqStVlxpRt_c0dks5tGAcOgaJpZM4RPn8g .

[quozl]

Thanks for your interest. But a new design by you? My initial response is No thanks; as far as I can see you haven't used the documentation as a developer on Sugar, so you aren't the target audience, and you may not know what that audience needs.

You mentioned it being simple or abstract; it is technical documentation, the audience is Python or JavaScript developers; so it needs to be accessible to developers. See for example my earlier issues #126 (For experts instructions still attracts people who aren't experts), and #121 (Accessibility; keyboard navigation does not work).

It's not an us vs them argument I'm making, but one of suitability and maintainability. This repository only contains the markdown sources for the site.

For colour, theme, appearance and user interface;

• it should be based on the project's main site, http://www.sugarlabs.org/ which in turn is based on the appearance of the Sugar desktop,
• since the site is closely related to our API documentation at https://developer.sugarlabs.org/sugar3/ the same should apply there; the API documentation is generated using Sphinx from sugar-toolkit-gtk3 repository,
• further, since the deeper API documentation hosted by other sites has new themes, colours, and JavaScript keyboard affordances, we should consider them; http://pygobject.readthedocs.io/en/latest/ and https://lazka.github.io/pgi-docs/

So tell us more about your design and how you would implement it?

[quozl]

We've moved this content to be hosted by GitHub repository view directly.

[hacktivist123]

Welcome to my weekly newsletter for developer advocates, software developers, and technical writers!

In the first issue, I'll share resources on technical writing, developer relations and acing technical interviews.

This is going to be a long one, so read until the end to get the most out of the newsletter.

Let's get started!

Interesting Content on Technical Writing, Developer Relations, and Software Dev from African Developers

• Gift Ojeabulu, A Developer Advocate from Nigeria was a host on the developerrelations.com DevRel Book Club. Watch the video here: https://www.youtube.com/watch?v=up_bW3Fds90

  • Confidence Okoghenun, A Developer Advocate from Nigeria made an interesting video on "Vim vs Vscode: Will You Be More Productive With Vim?" - Watch the video here: https://www.youtube.com/watch?v=ETJq-Tj94WI

  • Arafat Abdussalam wrote an interesting piece on "What is DevRel" - Read it here: https://arafatsalam.hashnode.dev/what-is-devrel-and-devrel-con https://arafatsalam.hashnode.dev/what-is-devrel-and-devrel-con

  • Dillion Megida made an interesting video on "How You Came Into DEVELOPER RELATIONS" - Watch the Video here: https://youtu.be/lgvu_CRL3wE

  • Kati Fratz made a free and very useful roadmap on learning Web Development - Get it here: https://roadmaps.growthletter.dev/ https://roadmaps.growthletter.dev/

  Technical Writing Content From Around the World

• Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code- https://www.dewanahmed.com/markdown-asciidoc-restructuredtext/

  • Kumar Dhanagopal - Don't trust the numbers! - https://www.youtube.com/watch?v=sLsohqs3tSE

  • Amruta Ranade shares her docs-as-code workflow as a technical writer in this Youtube Short video - https://www.youtube.com/shorts/btC6KFXtRfM

  • Top static site generators for technical writers - https://www.youtube.com/watch?v=BG_JHQOgh1I

  • Tech Writing Interview Questions and Answers Part 2 - https://zaycodes.hashnode.dev/answers-to-frequently-asked-questions-in-technical-writing-interviews-part-2-clb0ns8fn001208jydlwucyv3

  • Tech Writing Interview Questions and Answers Part 1 - https://zaycodes.hashnode.dev/answers-to-frequently-asked-questions-in-technical-writing-interviews-cl9nz9xnu000209jt90ej67uj

  Developer Relations Content From Around the World - Check out this interesting Twitter thread on the biggest mistake companies make in Developer Relations - https://twitter.com/ladyleet/status/1611162713681723394?s=20

  • Evolution of Developer Relations: How DevRel Helps to Build an Employer Brand - https://dev.to/juliamurashova/evolution-of-developer-relations-how-devrel-helps-to-build-an-employer-brand-3fko

  • Developer Relations: A Complete Guide to what it is, how it works, and whether you need it - https://www.youtube.com/watch?v=CN4Zzdg49VI https://www.youtube.com/watch?v=CN4Zzdg49VI

  • Useful resources for getting started in Developer Relations - https://gist.github.com/andypiper/7fdb73f9713b7e1f7e5e7ac373f635cb https://gist.github.com/andypiper/7fdb73f9713b7e1f7e5e7ac373f635cb

  • The Developer Advocacy Handbook - https://developer-advocacy.com

  • Every Company Needs a Developer Relations Team - http://blogs.newardassociates.com/blog/2022/devrel-for-all-companies.html

  • Developer Relations Guide to Not Being a Support Engineer - https://randomnodes.com/post/2022-12-13-not-support/

  • Why are we paying these folks - a tale of DevRel - https://www.dewanahmed.com/why-paying-devrel/ https://www.dewanahmed.com/why-paying-devrel/

  Interviewing Resources - Acing the DevRel Interview - http://thagomizer.com/blog/2019/10/11/acing-the-devrel-interview.html http://thagomizer.com/blog/2019/10/11/acing-the-devrel-interview.html?ref=devrelresourc.es

  • Amazon STAR method: What is it and How to Use It - https://interviewsteps.com/blogs/news/amazon-star-method

  • Teach Yourself Programming in Ten Years - https://norvig.com/21-days.html

  Notable DevRel Projects From Africa - Ada Nduka Oyom runs DevRel Lite, a platform where she shares DevRel-related content from across the world for newbies looking to get into the trade. Follow DevRel Lite on Twitter - https://twitter.com/devrellite

  • Linda Ikechukwu is curating a resource bank for Technical Writers at http://everythingtechnicalwriting.com

  • Shedrack Akintayo runs DevRel Community Africa https://devrelcomafrica.notion.site/DevRel-Community-Africa-7da776c74077430896a6d37b85fd1f32, a community of developer relations experts and enthusiasts across various countries in Africa.

  Content of the Day: In today's content of the day, we wanted to share an article on "5 Tips for Effective Technical Writing". Technical writing can be a daunting task for even the most experienced writers, but with a few simple tips, you can make your writing more effective and engaging for your audience. Some key points to keep in mind include:

  Know your audience: Make sure you understand who you are writing for and what their needs and interests are. This will help you tailor your writing to their specific needs.

  Use clear, concise language: Avoid jargon and complex technical terms whenever possible. Instead, use simple, easy-to-understand language that is easy for anyone to follow.

  Organize your content: Use headings, bullet points, and other formatting tools to help break up your content and make it easier to read.

  Use examples and illustrations: Examples and illustrations can help make complex concepts more understandable and easier to grasp.

  Review and revise: Don't be afraid to take the time to review and revise your writing. This will help ensure that it is clear, concise, and error-free.

  We hope these tips are helpful in your technical writing endeavours!

  Quotes of the Day: - "The first draft of anything is sht." - Ernest Hemingway*

  • "If a business is a machine, DevRel is the grease that turns the wheels, making everything function reliably. It improves efficiency." - Paul Burt

  And with that, we bring the inaugural issue of our "Develop by DevRelCom Africa" newsletter to a close. We hope you've enjoyed this first edition and are looking forward to the next one. Until then, remember to always keep an open mind and a sense of humour while navigating the exciting world of tech.

  Happy coding and Devrel-ing! Develop - DevRel Community Africa by Shedrack akintayo https://tinyletter.com/DevelopByDevRelCom Lagos Lagos mainland, Lagos 234111 Nigeria

Sent to @.*** Unsubscribe: https://tinyletter.com/DevelopByDevRelCom/unsub?c=b34680ab-ed4a-4165-aaee-ca0f959b7c33&m=the-inaugural-issue-of-the-develop-newsletter-by-shedrack-akintayo

Delivered by: http://tinyletter.com