Where we take good care of both your front and back-end needs
Great place to take your code to the next level
Checkout my work and get in touch
Written by Rastko
date - 22/Aug/18 | views - 93
This is a short article on rules I set on both myself and any future contributors to rastcodes.com.
It will include instructions on how to write guides, so that both industry professionals and newcomers can understand the topic.
Many tutorials tend to suffocate the text with technical vocabulary, which may be confusing and assumes the reader is already familiar with the phrase. Avoid doing this when possible. Especially, be careful when introducing properties of a specific language or a framework, because even professionals may find it hard to take new topics.
For example, writing about Java and OOP, may need further explanation on Object Oriented Programming, or at least a reference to an existing article on the topic.
Introducing an aspect of a programming language to a person with experience can be easier if you can find good comparisons to other, especially more common technologies.
Many people take new knowledge visually and helping them achieve this is a step further to a good guide. Avoid abstract examples and focus on the worldly topics.
For example, writing about a class A, which inherits from class B and implements an interface C with a method blob is very confusing. However, the same can be achieved by writing about a class Car, which inherits from class Vehicle and implements an interface MotorizedVehicle with a method startIgnition, uses empathy and therefore is better suited.
Try to divide your content into clear parts as readers will be able to assess the time need to complete a guide and if needed, take a break, without losing the trail of thought. Do this in both singular articles, as well as a guide series.
This style guide will improve as we go along, and we ask all to give us pointers.
Currently working on a Laravel projectCheck it out