If you struggle to create technical content that is easy to digest, this article is for you.

Where do I start?

If you don’t know where to start to create technical content, decide on the purpose of what you’re going to write.

Ask yourself the following questions:

• Why do you want to write that piece of content? Do you want to teach something to the user? Do you want to show the user how to solve a particular issue?

• What problem(s) are you trying to solve by writing a piece of content?

• Once the reader finishes reading the page, what do you want them to know?

• What’s the key takeaway (or takeaways) of the page?

Once you have reflected on the above questions, you should have a clear idea on what type of content you want the user to read. The type of content you want to write may follow under one of the following:

• User manual

• Tutorial

• Blog

• API documentation

And more.

How to structure technical content

Structuring technical content is essential to help users navigate and understand it effectively.

When you write technical content, you want to pay attention to the following:

• Formatting:

  • Headings and subheadings

  • Bulleted and numbered lists

  • Code blocks (if you want to add code)

  • Tables (beware that tables may not be mobile-friendly)

  • Images

• Consistency

How to format technical content

When to use headings and subheadings

A headings, also known as headline, appears once at the beginning of a page.

In the digital world, the headline of your content is what displays in bold when it shows up on the results page of a search engine.[Titanium Marketing]

Subheadings are always followed by by headings. You use subheadings to break down a page into multiple sections.

How to use bulleted and numbered lists

You use a bulleted lists when the order in which you present information isn’t important. On the other hand, you use a numbered list when you want the user to digest information in a certain order. It’s important to know this distinction, especially if you want to create tutorials.

Here’s an example of presenting information using a bulleted list:

• You can use Java to create a web application.

• You can use Java to create an Android app.

• You can use Java to to create enterprise applications.

In the example above, you can swap the order, and it wouldn’t make a difference to the user’s learning experience. In some cases, you may want to add the information you really want the user to know the most at the top of the list.

Here’s an example of presenting information using a numbered list:

1. Go to the website, and download the report.

2. Add the report to folder abc.

3. Open the report, and write your name, surname, and date of birth.

In the example above, if you swap the order of each item in the list, you’re going to disrupt the user’s experience. For example, if you tell the user to add the report to folder abc, the reader may wonder where they’re going to find the report in the first place.

Your purpose as a technical writer is to offer a seamless user experience by eliminating barriers that may lead the user to drop out of your content.

As someone who reads a lot of online content, I see this mistake too often: taking steps for granted, using bulleted lists instead of numbered lists, and vice versa.

Add code blocks

This is relevant if you want to add code blocks to your content.

Ensure code blocks and terminal commands are wrapped in triple backticks, so readers can easily copy and paste the code in to their editors/IDE.

Add tables

Tables are good at presenting information in a simple and concise manner. They don’t help with you want to present detailed information (in this case, you may want to use a bulleted list instead).

Beware of tables with too many columns and rows, as they’re often mobile-unfriendly.

Add images

Images are an excellent to ehance the content experience. Images can include:

• Diagrams

• Screenshots

• Videos

• Charts

And more.

Beware of adding visual content that can quickly go out of date.

How to write consistent content

Consistency in technical writing means that information is presented in a unified fashion. Consistency especially applies to formatting and grammar.

To give you an example: some specific terminologies are written in all capitals (an example of this is VAT).

Writing the same word in different ways throughout the content may imply that the word carries different meanings.

It’s your responsiblity as a technical writer to ensure that content is coherent from start to finish.

As you write content, revisit it to ensure that it stays consistent.

If you want to learn more about writing technical content, read the following resources:

• Elements of Technical Writing

• Top 6 Essential Technical Writing Skills

Over the years, LinkedIn has evolved by offering two types of experiences:

• Job searching

• Content creation

This article will describe how to maximize your LinkedIn for job search.

1. Update your personal information

Many LinkedIn accounts have outdated personal information. By personal information, I mean:

1. Your profile picture: Ideally, update your profile picture every 1-2 years. To update your profile photo:

   1. Select your profile picture.

   2. Select Add photo.

   3. Choose Use camera to take an instant picture, or Upload photo.

   4. Select Save photo.

Your contact information: Ensure you have your email address displayed on your email to allow other LinkedIn users to contact you directly. To update your contact information, select Contact info on your LinkedIn profile:

2. Update your profile intro

Your profile intro is where you tell other users about:

1. Basic info: Name and Surname

2. Pronouns

3. Headline: Here, you can add your job title.

4. Current position

5. Industry

6. Education

7. Location

To update your profile intro, select the pencil icon on the right:

3. Add or update the experience section

The experience section is the most compelling section of your profile. Unlike a CV, you can add all your work experience on LinkedIn, ideal if you've been in the workforce for over 10 years. To add experiences to your profile:

1. Select the + button under Experience:

2. Select Add position.

3. Fill in all the required information:

• Title

• Company name

• Start date - End date

• Add skill: Adding a skill allows you to keep track of your skills in a specific job and helps recruiters search for candidates with certain skills. Add up to five skills for each position.

Add positions within the same company

LinkedIn allows you to showcase the positions in the same company as part of a singular experience. An example is this:

Use this LinkedIn feature to:

• Reflect on the work done within the company: The example above displays the transition from one product group to another.

• Reflect promotions.

To add multiple experiences within the same company:

1. Add one experience, but ensure you add the following:

   1. End date.

   2. Company name.

2. Add a second experience with the same company name (the URL must be the same) as the above-mentioned step. LinkedIn will automatically rearrange the experience, as in the screenshot above.

4. Add education section

On LinkedIn, you can choose to add an education section. Add this section to:

• Display any bachelor's degree, master's degree, or PhD.

• Any academy attended.

• Any professional school attended.

To add an education section:

1. Select Add profile section.

2. Select Add education.

5. Add certifications

LinkedIn allows you to list any certification on your profile. Certifications can be:

• Information Technology and Computer Science certifications, such as AWS certifications, CompTIA certifications, etc.

• Project management certifications.

• Language proficiency certifications.

To add certifications:

1. Select Add profile section.

2. Select Recommended.

3. Select Add licenses & certifications.

6. Use LinkedIn search

LinkedIn search is a powerful feature that helps people find jobs, companies, and more.

How to use LinkedIn search for jobs

To search for jobs on LinkedIn, on the search bar:

1. Enter "software engineer" (or any other jobs you're looking for). Try adding double quotes if the search returns unrelated results.

2. Select the Jobs filter.

3. LinkedIn search allows you to narrow down your search. For example, you can search for a remote, entry-level job with a salary of no less than £30,000 a year. To do this:

   1. Select Experience level > Entry level (and/or Associate) > Show results.

   2. Select Salary > £30,000+ > Show results.

   3. Select Remote > Remote > Show results.

How to use Boolean search

You may notice that LinkedIn returns unrelated results despite entering "software engineer" in the search bar. To ensure LinkedIn search returns more related results, you can use AND, NOT, or OR in the search bar. The keywords must be in a capital case. An example is this:

1. You entered software engineer in the search bar, but you also get DevOps roles:

To exclude DevOps roles, enter "software engineer NOT devops", and you should receive more related results:

You can perform a similar search with AND, and OR.

How to use LinkedIn to search for recruiters

LinkedIn allows you to search for people in general. However, I want to teach you how to search for recruiters who work at a specific company in this article. To do this:

1. On the search bar, enter "Technical recruiter".

2. Select People at the top.

3. Select Current company, and choose Meta (or any other company).

4. Select Show results.

The screenshot above displays all the technical recruiters employed at Meta.

7. Add a Skills section

The Skills section allows you to list all your skills.

To add skills to your profile:

1. Select Add profile section at the top of your profile.

2. Select Core > Add skills:

3. Select all the skills that apply to you.

4. Select Save.

• Information Architecture

• Docs-as-code

• Content strategy

Information Architecture (IA)

What is information architecture?

Information architecture means organizing and presenting information in a logical and easy-to-find way for users. It is essential because it allows users to find what they need quickly.

It might sound simple, but IA is more than simply presenting content in a clear and concise way—it’s about creating a logical navigation structure that helps users find what they’re looking for without getting confused or frustrated.[UX Design Institute]

When you review documentation looking for information, you may notice that it has two components: organization and naming. Organization means that content is structured into categories. Naming means using words to represent each category.

Why is IA important?

Information architecture is important for the user and the business.

Nowadays, people want to find what they need as soon as possible. Users don't want to spend too much time finding information. They'll click off your site and potentially go to a competitor who may give them what they want sooner. Good IA has a significant impact on user experience.

The faster the users get to their final destination, even if that destination includes multiple options, the greater their satisfaction.[CareerFoundry]

For a company, unstructured IA may result in:

• Lost customers.

• Bad reputation.

• Lost sales.

• Reduced SEO ranking.

• Increased cost of customer support.

Docs-as-code

Documentation-as-code (Docs-as-code) is the process of writing and maintaining documentation the same you write and maintain code.

This means:

• Using version control.

• Performing code reviews.

• Using issue trackers (such as JIRA).

• Using markdown (or other text mark up).

Docs-as-code allows technical writers and software engineers to collaborate and contribute to the documentation. Docs-as-code empowers technical writers to ensure that documentation meets its highest standards.

As part of my job, I sometimes block pull requests from being merged until they are rewritten to comply with the style guide.

Content strategy

A content strategy is the planning, creation, publication, management, and governance of content.[HubSpot Blog]

In technical writing, content strategy means ensuring the documentation caters to the target audience.

Why do you need a content strategy?

The purpose of content strategy is to create meaningful, cohesive, engaging, and sustainable content that attracts the company’s target customers.[7 Powerful Reasons Why Everything Begins with Content Strategy]

Consistency

A content strategy gives the documentation consistency. Consistency means that users know where to find information easily, which helps improve the overall user experience of the documentation.

Search Engine Optimization

The company ranks higher on search engines when documentation follows a structured content strategy.

Conclusion and Next Steps

By mastering these key elements, you can create documentation that engages readers and allows them to comprehend even the most intricate concepts.

Mastering the art of technical writing is a continuous learning process.

My first year as a technical writer taught me a lot about technical writing, and I feel that my interpersonal skills have grown significantly in the past 12 months.

Work-life balance

Work-life balance is subjective because it depends on the company and, more specifically, the team. My work-life balance as a technical writer is the best I've ever had.

When I was a software engineer, I found it difficult to completely switch off from work.

I was concerned about things breaking, finding a solution to a bug, not being able to complete tasks within tight deadlines, impressing my manager, and so on.

As a technical writer, I still have deadlines and tasks to complete by a specific date, but overall, deadlines have been more relaxed.

I can switch off from work, I'm not concerned about things breaking, and there's no "urgency" because content is not mission-critical.

Blogging is different from technical writing

In my first 3-6 months, I learned how to write as a technical writer. Before becoming a professional technical writer, I've been writing on this blog since 2021.

Blogging helped me a lot with my current role, but I still had to learn about:

• Technical communication

• Information Architecture

• Markdown

• User journey

• Docs-as-code

In addition to the topics above, I've also learned about the company's and the team's processes. This has been an enormous learning curve, but having the right manager and supportive colleagues has made the learning enjoyable and not overwhelming.

Technical writing is more sterile and straight-to-the-point than blogging. I had to learn to cut out the fluff and tell the user what they needed to do to use the product without adding words that add no value.

You have to advocate for yourself

As a technical writer, you'll often have to advocate for yourself. Technical writing is an underrated and taken-for-granted role.

Sometimes, software documentation is not considered part of a successful product but is more like a side-project ("after-thought").

As a technical writer, you must speak up often, advocate for your work, proactively engage with the SMEs (subject matter experts), and participate in all the meetings necessary to perform your role successfully.

Technical writing is about asking the right questions

Technical writers are responsible for identifying the information the users need to use a product successfully, and create content from there.

Since software engineers are responsible for building the product, technical writers must ask questions to access the knowledge they need to write the documentation.

Software engineers build the product, but they don't know (or take for granted) what the users need to use the product from scratch.

Project management

When I started my role, I was surprised by how project management plays an integral part in ensuring that I track my work. I use JIRA on a day-to-day basis to:

• Create tickets.

• Track how many tickets I close per Sprint.

• Track the progress of each product's documentation.

Commonalities between software engineering and technical writing

Both software engineers and technical writers:

• Use Git (or other version control) and GitHub.

• Use an IDE.

• Follow an Agile process.

• Both are built for the users (but from different perspectives).

• Perform peer reviews.

Technical writers write little to no coding and are more concerned with creating user-focused documentation.

Conclusion

After reading this article, you have an idea of what a technical writer does.

If this article is interesting to you, subscribe to my FREE weekly newsletter.

Job hopping used to be taboo, but changing jobs every two to three years has become widely accepted.

There has been a generational shift in the last few years: years ago, employees worked for the same company for decades and wanted to be loyal.

“Rather than letting their progress be dictated by a single employer, many workers felt empowered to actively manage their own careers: moving between companies as needed to advance, gain new skills or look for new opportunities.”[The case for job hopping]

Over the last few years, though, employees have been rejecting the notion of company loyalty and starting to do what suits them best.

[...]They should be intentional and strategic with each career move, and they need to be prepared to explain those transitions when discussing their job history with future employers.[What Is Job Hopping? (Pros, Cons and Considerations)]

What are the positive aspects of job hopping?

Higher salary

When you stay in the same company for several years, the usual salary increase you can get is 4%. However, when you change jobs, you can receive a significant pay rise of 8%+.

Variety of experience

Changing jobs frequently exposes you to various skills and domains you wouldn't be able to gain if you stayed at the same company for a long time.

Adaptability

Changing jobs frequently may also signal that you can quickly adapt to a new environment and, therefore, impact the company soon.

Career growth

Managers cannot always give you a promotion for reasons outside their control (position not being available, budget not being enough, hierarchy, etc.). Job hopping allows you to get your desired promotion at a different company.

New environment

Job hopping allows you to experience a new environment with new colleagues and managers and perhaps better internal processes.

How can job hopping hurt your career?

Limited professional growth

When you frequently switch jobs, you cannot absorb enough information and experience to be successful in the long run. When you stay in the same company for a reasonable amount of time (3+ years), you learn the company's domain and the business challenges the domain may carry. This knowledge can significantly benefit you in the future.

“An employee moving jobs too often can mean they aren’t in a position long enough to truly learn the role or gain new skills,” says Thomas. “It can ultimately damage a person’s career: it may be challenging to demonstrate to a new employer previous proficiency and achievements.”[The case for job hopping]

Weak social connections

Switching jobs too frequently doesn't allow you to build solid connections with your colleagues. This may hurt you if you ever need a referral or endorsement from a colleague in the future. Having a solid network is crucial, especially during these difficult times.

It may look bad on your resume

Even though switching jobs frequently has mainly become accepted, some recruiters and hiring managers may be reluctant to consider someone who displays a pattern of consistently changing jobs on their resume.

Is job hopping in tech bad in the end?

This depends on how you go about job-hopping.

If you intend to job-hop solely to get a salary bump, you'll eventually reach a point where it becomes unsustainable.

However, job hopping strategically can benefit your career when you stay in a job long enough to gain skills and experience you can leverage in your next role.

A balanced approach would be ideal. Staying at a job for less than a year isn't smart, but working for the same company for 10+ years would mean leaving too much money on the table.

The ideal approach would be to have a balance between short and long job experiences.

Subscribe to my FREE weekly newsletter if you enjoyed this article.

1. Understand the Problem

At the heart of programming lies problem-solving. Focus on the issues you're aiming to solve. Clearly define the boundaries of your solution, making it manageable and expressive.

Once these boundaries are set, explore both inside and outside the box. A crucial tip: Learn programming, not just programming languages. Knowing the best stack for software development helps understand the underlying problem to adapt seamlessly between projects.

2. Use the correct tool

Every programmer possesses knowledge of data structures, algorithms, design patterns, and deployment application tools.

Regularly refresh your skills by staying updated on industry news. Regarding deployment tools, explore all API options and understand why they use them.

Let your tasks dictate the tools, not the other way around. If you're breaking new ground, be open to developing new tools.

3. Keep your solution simple

Strive for simplicity in your solutions. Aim for easy comprehension, explainability, and maintainability for bug fixes or new features.

Seek the sweet spot where your product is user-friendly for novices and enables advanced users to perform clever tasks.

Remember: simple doesn't mean simplistic. You can have simple rules that enable complex behaviour.

4. Practice continuously

Becoming a proficient software developer is a gradual process. Embrace continuous learning to expand your skill set.

Contribute to open source projects, help friends' startups, provide feedback, fix bugs, and explore new programming languages, stacks, and tools. Consider sharing your knowledge through YouTube tutorials or blogging.

5. Learn to debug

Debugging skills accumulate over time. Embrace opportunities to debug, as the process is more valuable than fixing the bug itself.

Debugging enhances your understanding of code, intuition, and insights into software. Don't give up, even if it takes hours. If you need help, use StackOverflow and/or ChatGPT.

6. Exercise and rest

Programming demands both mental and physical endurance. Stay fit for better concentration. When stuck on a bug, exercise physically, like jogging or swimming, to refresh your mind.

Take regular breaks, and disconnect from tech devices periodically. A comfortable keyboard is also recommended for extended comfort.

7. Learn from Your Projects

Reflect on past projects to understand what worked and what didn't. Anticipate the skills needed for future projects.

Keep a record of interesting articles, read engineering blogs, and stay updated on industry knowledge. This awareness will guide you in choosing the right tools for your next project.

8. Take Breaks

Taking breaks is crucial. Staying back for a breather can do wonders when you're stuck on a problem. An example is to use the Pomodoro Technique. The Pomodoro Technique consists of short bursts of work followed by breaks.

These breaks not only refresh your brain but also supercharge your productivity.

9. Seeking Assistance

There's absolutely nothing wrong with not knowing something. Whether you're a college student or a seasoned developer, don't hesitate to seek help when you're unsure.

Dive into books, watch tutorials, and reach out to your seniors or fellow developers. If you have the expertise, extend a helping hand to others. It's about gaining knowledge and fostering career growth.

Many programmers shy away from asking for help, but it's not a sign of ignorance. It's a step towards understanding concepts more deeply.

10. Continuous Learning

The tech world is vast, with technologies evolving or becoming obsolete. Keep your radar tuned to emerging trends. Engage in side projects and stay informed about new frameworks, libraries, or languages.

Dive into blogs, write your own, and contribute fresh ideas to your company.

Remember, your learning journey doesn't stop when you enter the programming realm. Stay curious, stay updated, share your knowledge, and consistently explore to fuel your growth as a programmer.

11. Sharing Ideas and Knowledge

In the wise words of Albert Einstein, "If you can’t explain it simply, you don’t understand it well enough." As you become a proficient developer or programmer, don't hoard knowledge—share it.

Whether it's through writing blogs, teaching someone, or offering help, sharing your insights benefits others and enhances your skills. Embrace constructive feedback and criticism. It's a pathway to improvement. Be open to different opinions and learn from them.

12. Crafting Clean, Reusable, and Efficient Code

A key habit for any good developer is to write code that is clean, efficient, and easy to understand.

Follow the DRY (Do Not Repeat Yourself) principle: when you spot repetitive code, create a function to handle it. Documentation, comments, and a clean code structure are your allies.

Make your code understandable for other developers:

• Use meaningful naming conventions, use Camel case, and ensure your CSS or JS is minified.

• Compress images to keep your projects nimble. Thorough testing is crucial. While simplicity is often preferred, sometimes it's okay to write spaghetti code if it makes things clearer and more manageable.

• Strive for a balance between simplicity and complexity.

13. Patience

Learning the ropes, getting comfortable, and truly grasping concepts takes time in programming. Whether you're a beginner or a seasoned developer, patience is your ally when tackling challenges.

Don't let frustration overwhelm you when faced with complex problems. Many beginners throw in the towel too early, feeling overwhelmed or scared. It's essential to understand that becoming an expert programmer is a gradual process.

Take small steps every day, and allocate time not just for coding but also for yourself, your family, and your hobbies. Success in programming is a marathon, not a sprint.

14. Navigating Co-Worker Dynamics

Becoming a skilled programmer isn't just about churning out code. It's also about collaboration and handling differing opinions. Respect and consider others' ideas, even if they clash with yours.

Effectively managing conflicting solutions and handling pressure is vital in a team setting. Many companies emphasize cultural fit for a reason. Be open-minded, avoid arrogance, and communicate effectively to address issues.

Seasoned developers, despite their expertise, sometimes falter in handling co-worker dynamics. Learn from your mistakes, stay open to constructive discussions, and foster a positive collaborative environment.

Conclusion

Cultivating effective programming habits is crucial for software developers seeking to enhance their efficiency and produce high-quality code.

The most recommended programming habits, including regular code reviews, version control utilization, and consistent documentation, contribute to a more collaborative and streamlined development process.

Embracing a proactive approach to problem-solving, continuous learning, and adopting coding standards further elevates a developer's skill set.

Prioritizing clear communication within the team and through well-commented code fosters a positive and productive working environment.

Ultimately, integrating these habits enhances individual performance and significantly contributes to the overall success of software development projects.

If you enjoyed this article, consider subscribing to my FREE weekly newsletter.

CodiumAI analyzes the entirety of your code and then suggests tests as you code.

CodiumAI's main vision is to help developers create better code faster.

To use CodiumAI, you will need:

1. VS Code or JetBrains IDE installed on your laptop.

2. Go to CodiumAI and download CodiumAI on your laptop.

This tutorial uses Visual Studio Code with Java.

Once you have Visual Studio Code installed on your laptop, on CodiumAI, select the option to download the free version of your Visual Studio Code.

How to use CodiumAI on Visual Studio Code

Create a Java project on your Visual Studio Code called CodiumAI_Project.

Once you have created your project, open it on your Visual Studio Code.

This is what you should see:

Select the CodiumAI icon at the bottom of the left sidebar to use CodiumAI on Visual Studio Code:

At the bottom, select No Context. Selecting No Context allows you to ask a question without context. For example, you can ask CodiumAI to generate a class called Vehicle with brand, colour and purpose_of_use as private fields.

The code generated will initially be written in Python like this:

class Vehicle:
    def __init__(self, brand, colour, purpose_of_use):
        self.__brand = brand
        self.__colour = colour
        self.__purpose_of_use = purpose_of_use

    # getter methods
    def get_brand(self):
        return self.__brand

    def get_colour(self):
        return self.__colour

    def get_purpose_of_use(self):
        return self.__purpose_of_use

    # setter methods
    def set_brand(self, brand):
        self.__brand = brand

    def set_colour(self, colour):
        self.__colour = colour

    def set_purpose_of_use(self, purpose_of_use):
        self.__purpose_of_use = purpose_of_use

CodiumAI allows you to translate code from one programming language to another. Since this tutorial uses Java, you can translate the Python-generated code into Java.

Select Continue this chat, and ask CodiumAI to change the code to Java.

public class Vehicle {
    private String brand;
    private String colour;
    private String purposeOfUse;

    // constructor
    public Vehicle(String brand, String colour, String purposeOfUse) {
        this.brand = brand;
        this.colour = colour;
        this.purposeOfUse = purposeOfUse;
    }

    // getter methods
    public String getBrand() {
        return this.brand;
    }

    public String getColour() {
        return this.colour;
    }

    public String getPurposeOfUse() {
        return this.purposeOfUse;
    }

    // setter methods
    public void setBrand(String brand) {
        this.brand = brand;
    }

    public void setColour(String colour) {
        this.colour = colour;
    }

    public void setPurposeOfUse(String purposeOfUse) {
        this.purposeOfUse = purposeOfUse;
    }
}

With CodiumAI, you can generate a test suite for your desired code. Select Continue this chat, and ask CodiumAI to generate tests for the above class Vehicle.

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class VehicleTest {
    @Test
    public void testVehicle() {
        // create an instance of Vehicle
        Vehicle vehicle = new Vehicle("Toyota", "Red", "Personal");

        // test getters
        assertEquals("Toyota", vehicle.getBrand());
        assertEquals("Red", vehicle.getColour());
        assertEquals("Personal", vehicle.getPurposeOfUse());

        // test setters
        vehicle.setBrand("Honda");
        vehicle.setColour("Blue");
        vehicle.setPurposeOfUse("Commercial");

        assertEquals("Honda", vehicle.getBrand());
        assertEquals("Blue", vehicle.getColour());
        assertEquals("Commercial", vehicle.getPurposeOfUse());
    }
}

CodiumAI features

CodiumAI:

• AlphaCodium: a test-based, multi-stage, code-oriented iterative flow that improves the performance of LLMs on code problems.

• Supports any language, even though advanced features are available in Python, JavaScript, TypeScript, and Java.

• Allows you to spend more time writing core features instead of tests.

• Helps you create bug-free software by thoroughly analyzing your code for edge cases.

To start using CodiumAI, refer to the CodiumAI website.

Further reading:

• AlphaCodium: State-of-the-art generation code.

• IntegrityAgent: Build Fast with Confidence using CodiumAI.

• CodiumAI Developer's Hub.

• Career growth.

• Lifestyle and wellness.

• Travel and exploration.

• Community.

Career growth

In April 2023, I quit software engineering and started a new position as a technical writer for Cloudflare's developer platform.

2023 has made me realize that software engineering is not a role that suits me.

For a long time, I believed I could be a software engineer with "enough practice".

The more I worked as a software engineer, the more I realized I wasn't meant to be one. There's a difference between being "a developer" and being a "competent developer".

I often felt disengaged with the type of work, disagreeing with the Agile practices, and not feeling psychologically safe in the environments I was part of.

The companies I joined as a software engineer were not for me, and I wasn't for them either.

I tried being a software engineer three times but said to myself that I wasn't going to try a 4th time if I felt that the situation was not improving.

Earlier this year, I started sending CVs for positions that involved more communication (either written or verbal).

I initially sent a CV for a Solutions Engineer role at Cloudflare but got rejected because I had no experience. I sent another CV for a technical writer role at the same company and got offered a role, which I immediately accepted.

When I told some people that I would switch to technical writing, they answered that I would feel bored because it's repetitive work.

My experience so far has been far from this:

• As a technical writer, I get paid to learn.

• It's an educating job where I teach users about a product.

• It's a role that drives innovation, competitiveness and customer satisfaction.

As a technical writer, I have more relaxed deadlines, I don't have to deal with bugs, on-call shifts are non-existent, there's no real "emergency", and you get to know your users.

Joining Cloudflare has been a smart move because:

• I use my writing skills to educate users on using products to build their applications.

• I learn about cyber security.

• I learn about Artificial Intelligence and other cutting-edge technologies.

My peace of mind has improved since shifting to technical writing, and I enjoy a better work-life balance.

Lifestyle and wellness

In 2023, I wanted to dedicate more time to improving my physical and mental wellness, with a slight focus on mental health, because it's easier to neglect.

How did I take care of my mental health?

Therapy

Seeing a therapist has helped me improve my self-esteem, gain new insights about my personality, and learn how to create boundaries with others.

Reduce social media consumption

Reducing social media consumption has helped me minimize exposure to harmful or triggering content, recognize and prioritize the value of real-life, genuine interactions.

Spending time in nature

When I'm not hitting the gym, I walk at one of London's many parks, and it's a great way to start my day.

Travel and exploration

I've been blessed enough to travel to two countries this year: Istanbul (Turkey) and Bali (Indonesia).

Of the two, I enjoyed my trip to Bali: I spent loads of time in nature (rice fields, forests, waterfalls, beaches), eating smoothie bowls, doing yoga, and massages.

I tried snorkelling in Indonesia, and it was an experience that allowed me to feel connected to nature.

Community and relationships

GT Scholars

GT Scholars is a social enterprise that runs programmes that help young people achieve their academic and career aspirations. I've been partnering with them since 2021, contributing to their blogging section on their website.

In 2023, I was the Lead Event Coordinator for a social mobility project dedicated to young boys, helping them gain the skills needed to succeed in their lives and careers.

This project ran for about three months, and it involved weekend workshops where the teenagers would group to learn about entrepreneurship, growth mindset, emotional intelligence, etc.

Black Woman in Tech Event

I was one of the panellists for Cloudflare's Black Woman in Tech event in October 2023. The event went better than expected, it felt like a conversation among friends, and there was a strong community feeling.

Conclusion

The overall theme for 2023 was about experiences. I experienced new hobbies, countries, people, and projects. I'm grateful for everything I experienced, and I hope 2024 will bring even more authentic experiences.

Happy New Year! 🎉

Agile methodology, born out of a need for adaptability and collaboration, provides a dynamic framework that prioritizes iterative progress, customer feedback, and constant communication among team members. This introduction aims to delve into the fundamental principles and key elements that define Agile software development, shedding light on its origins, core values, and the profound impact it has had on the efficiency and success of software projects.

What is Agile software development?

Agile is a way of creating software that focuses on flexibility and practicality in delivering the final product. It differs from traditional methods because it concentrates on building smaller parts of the software rather than the entire thing. This approach requires companies to change how they work.

There are several benefits to using Agile software development:

• It helps teams adapt to changes while efficiently delivering what the business needs.

• Agile encourages teamwork and a better understanding of everyone's roles.

• Because testing happens throughout the development process, companies can be more confident in the product quality they release. This allows them to fix problems early on.

Agile has become more popular than the older "waterfall" method in many companies. However, there's a chance it might be overshadowed by the rise of DevOps, which focuses on collaboration between development and operations teams.

Why is agile so popular?

Agile is popular because it offers a flexible and effective way of working. Agile started in software development, where teams used it to speed up their projects and shorten the time between creating new products. Many other types of companies are also adopting Agile to make their work faster and more adaptable to the quickly evolving future.

A study conducted by Organize Agile found that nearly half of all organizations in 19 countries have been using Agile for three years or more. This shows how widely it's being adopted across different industries.

How does Agile software development work?

1. Define the project

The team and the customer set the project's goals, objectives, and requirements.

2. Create a backlog

This is a prioritized list of tasks that need to be done. The customer, product owner, and team collaborate to create this list.

3. Plan the sprint

The team chooses the most important tasks from the backlog and decides how much work can be done in a set period (called a sprint).

4. Execute the sprint

The team works on completing the chosen tasks during the sprint, holding daily meetings to track progress and solve any problems.

5. Review and demo

At the end of the sprint, the team shows the completed work to the customer and gathers feedback.

6. Retrospect

The team discusses what went well, what didn't, and what can be improved for the next sprint.

7. Repeat

This process continues for each sprint until the project is finished. The product is developed and delivered in smaller portions.

8. Continuously improve

Agile encourages ongoing improvement. The team reflects on its progress and makes changes to enhance processes, tools, and communication for future sprints.

Core Principles of Agile Software Development Methodology

The Agile software development methodology is guided by several core principles that make a process Agile:

Iterative Development

Projects are broken into short cycles (iterations) where small parts are developed and delivered. This allows for continuous improvements and feedback.

Customer Collaboration

Regular interaction with customers and stakeholders ensures the project meets their needs. Working closely with them helps refine requirements and prioritize tasks.

Adaptive Planning

Agile doesn't rely on strict upfront planning. Instead, it welcomes changing requirements and adjusts plans accordingly, enabling teams to respond to changing situations effectively.

Continuous Feedback

Agile thrives on frequent feedback loops. Regular reviews and retrospectives help teams identify areas for improvement, fostering a culture of continuous learning.

Empowered Teams

Agile gives cross-functional teams the freedom to make decisions. This autonomy boosts accountability, innovation, and a sense of ownership over the project's success.

These principles guide Agile, making it a top choice for many organizations globally.

Key Agile Development Concepts

Some important concepts in Agile development:

User Stories

These are functional units of work divided by the team with input from the client or product owner. Each user story contributes value to the final product.

Daily Meeting

The team gathers daily at a set time to share updates necessary for coordination.

Personas

In some projects, the team creates detailed profiles of hypothetical users of the product to understand their needs better.

Team

A small group of people working full-time on the same project or task is called a "team" in Agile.

Incremental Development

Agile teams prefer an approach where each product iteration improves upon the previous one by adding visible functionality.

Iterative Development

Agile allows for repeating and revisiting development activities, intentionally incorporating iterative cycles.

Milestone Retrospective

After working on a project for a while, the team sets aside time, typically one to three days, to reflect on key moments and lessons learned.

These concepts are fundamental to Agile and are used to ensure efficient and effective development processes.

Popular Tools in Agile Software Development

Extreme Programming (XP)

XP is a framework that helps teams create high-quality software by emphasizing proper engineering practices. It's useful for handling changing software requirements, working in small, closely-knit teams, and utilizing automated unit and functional tests.

Kanban

This method is used to visualize, manage, and improve workflow. Kanban helps organizations see their work progress and limits work in progress. It's beneficial when work arrives unpredictably and needs immediate deployment without waiting for other tasks.

Lean

Lean consists of tools and principles to identify and eliminate waste to speed up process development. It focuses on maximizing value while minimizing waste and is applicable across various industries that generate waste.

Scrum

Scrum is a framework teams use to set hypotheses, test them, reflect on the outcomes, and make adjustments. It allows teams to adopt practices from other frameworks as needed. It's popular among cross-functional teams working on product development, dividing work into iterations lasting 2-4 weeks.

Crystal

Crystal emphasizes people and interactions over tools and processes. It aims to streamline processes and optimize work by recognizing that each project is unique and dynamic. It's utilized when improving team communication, integrating continuously, involving active users, and adapting processes are essential.

These tools and frameworks are widely used in Agile software development to improve processes, collaboration, and product quality.

The Waterfall Model in Agile Software Development

The waterfall model is an older approach to making software. It involves following steps one by one and only moving on to the next step once the previous one is done.

Let's look at the steps of the waterfall model:

• Requirement Gathering and Analysis: Everything the system needs to do is collected and written down.

• System Design: A plan is made for how the system will work based on the requirements collected earlier.

• Implementation: Small parts of the system are built and tested separately. These parts are then put together.

• Integration and Testing: All the parts are assembled and tested to ensure they work well together.

• Deployment of System: Once everything works correctly, it's made available for the customer or released in the market.

• Maintenance: Fixes and improvements are made as needed, handling any issues that come up after the system is in use.

Not every project fits perfectly into the waterfall model or Agile methods. Sometimes, a mix of both, called Agile-Waterfall, works best. For instance, planning and design might follow a waterfall method while development uses Agile's shorter cycles.

Disadvantages of the waterfall model

Certainly! Here are the drawbacks or disadvantages of the waterfall model in simpler terms:

• Late Software Development: In the waterfall model, working software isn't created until later in the project timeline.

• High Risk and Uncertainty: There's a significant amount of risk and uncertainty due to the linear nature of the model, which doesn't adapt well to changes.

• Not Suitable for Complex or Object-Oriented Projects: It's not the best fit for complex projects involving object-oriented software development.

• Unsuitable for long or ongoing projects: The waterfall model isn't well-suited for lengthy or continuous projects due to its rigid structure.

• Difficult progress measurement: Measuring progress accurately within different stages of the project is challenging.

• Inflexibility in handling changing requirements: It's hard to accommodate changes in requirements once a stage is completed.

• Lack of focus on end-user/client needs: The model might not prioritize or focus enough on meeting the needs of the end-users or clients.

• Delayed testing until project completion: Testing is often delayed until the entire project is finished, which can lead to potential issues being discovered late in the process.

Conclusion:

In conclusion, Agile software development stands as a beacon of innovation in the dynamic world of software engineering. From its inception to widespread adoption, Agile has proven to be more than just a methodology; it's a mindset that embraces change, values collaboration, and puts the customer at the forefront of the development process. Agile's iterative nature accelerates project delivery and enhances the ability to respond swiftly to shifting requirements and emerging challenges. Agile remains a cornerstone for fostering adaptability, resilience, and customer satisfaction as technology evolves. In essence, the principles of Agile software development serve as a guiding philosophy, steering development teams toward a future where flexibility, collaboration, and continuous improvement are not just aspirations but integral components of successful software delivery.

If you enjoyed this article, subscribe to my FREE weekly newsletter.

Faq’s

What is Agile?

Agile is a flexible and adaptive methodology used to manage projects. Its core focus is on prioritizing adaptability and continuous improvement rather than rigidly following a fixed plan.

What are the Four Principles of Agile?

The four guiding principles of Agile are valuing individuals and their interactions, emphasizing working software, fostering customer collaboration, and being responsive to change. A typical example of Agile methodology is Scrum.

Can you give an example of Agile?

Scrum is an instance of Agile methodology, a framework utilized to manage and accomplish intricate projects. It's commonly applied in software development but can extend to other fields. Scrum aligns with Agile principles, emphasizing flexibility and continuous enhancement. It utilizes short iterations, known as sprints, to monitor and handle progress.

What is the Core Concept of Agile?

The fundamental idea behind Agile is to prioritize adaptability and continuous improvement above rigid planning. Agile methods aim to swiftly and effectively deliver functional software by being adaptable and responsive to evolving requirements and priorities. Additionally, Agile stresses collaboration among teams, customers, and stakeholders, promoting open communication and transparency throughout a project's lifespan.

This article delves into the essential skills that every technical writer should possess, from mastering the fundamentals of grammar and style to adapting content for diverse audiences.

Communication

Communication is the core skill of a technical writer. Communication is made of written and verbal communication. Technical writers need written communication skills to convert complex information into easy-to-understand documentation.

Technical writers need verbal communication to communicate with immediate team members and stakeholders.

Teamwork

Technical writing is a job that needs cross-functional effort.

Documentation is written and maintained by a team of technical writers and members of other teams (such as content designers, software engineers, product managers, and more).

[...]A user guide can only be clear and make sense when its author knows how everything works. So, there’s always a lot of communication and inquiries about all sorts of things.[ClickHelp]

Documentation as Code

Documentation as code (also known as Docs as Code) is a process to create and publish documentation.

Documentation as code uses the same tools and processes in the software development lifecycle, with the main difference being documentation instead of code. These tools and processes are:

• Git (Version Control).

• Code Reviews (where another technical writer reviews your documentation before merging).

• Automated Tests.

• Issue Trackers (such as JIRA).

Documentation as code fosters a culture of ownership and collaboration.

User experience

Technical writers are user advocates and play a massive role in the success of a product. They understand what the audience needs and write directly for them. Technical writers know what information users need to make the most out of the product and use that information to create the documentation.

Research skills

Technical writers spend a lot of their time researching. Researching includes:

• Audience Analysis: this type of research helps the technical writer understand the target audience.

• User Experience: this type of research helps the technical writer understand the readability of technical documentation.

Editing skills

Besides writing, technical writing involves a lot of editing. Editing includes:

• Content review.

• Spelling and punctuation (although this step can be partially automated).

• Proofreading.

Conclusion

After reading this article, you've learned about essential technical writing skills.

If this article was helpful to you, consider subscribing to my FREE weekly newsletter, where I share more insights like this.

However, software developers contribute to internal or external documentation in many companies. And this is where software developers struggle.

This article shares tips to help you become a better writer and create better documentation.

1. Know your audience

Knowing your audience means understanding who you're writing for. Are you writing for experienced people or beginners?

Knowing your audience helps you evaluate whether you need to include or omit certain information.

For example, if you're writing content on "How to send an HTTP PUT request", you may want to specify what HTTP means if you're writing for beginners. If you're not, you can omit the information and your readers will still understand your content.

2. Be user-oriented

Technical writers are user advocates. They care about the user experience. If you want to improve your writing, keep your reader in mind throughout your writing process.

Writing user-oriented content means responding to users' intent.

If you want to write user-oriented content, respond to users' intentions - meet their needs before they realize they have them, and always be one step ahead.[Delante]

3. Logically structure your content

Structuring your content logically means laying out information so your reader can smoothly jump from paragraph to paragraph. Logical content feels clear and confusion-free.

Readers don’t want bumps, unintended surprises or to feel threatened in any way. They don’t want to follow a train of thought, only for it to lead to a dead-end, or for a new idea to be dumped on them without warning.[The Writers College]

How can you achieve a logical flow in your content?

1. Outline your ideas: Write the information you want your user to know on a piece of paper or editor. This step helps you clearly understand what you want to write.

2. Plan the flow of your writing. This step helps you visualize what works and what doesn't before you start writing, potentially saving you time.

3. Address each point at a time, and ensure there's a clear connection between paragraphs.

4. Use subheadings. Some readers read thoroughly, and other readers are skimmers. Write for both types of readers.

5. Use lists: use bulleted and numbered lists. Use bulleted lists when you want to list facts. Bulleted lists are ideal when the order doesn't matter. Use numbered lists when the order is essential.

4. Format your content

Formatting means how you want your content to appear. Formatting includes headings, subheadings, paragraph length, links, etc.

To format your content:

• Use code blocks where necessary.

• Break down lengthy paragraphs into shorter paragraphs.

• Use H1, H2, and H3 subheadings accordingly.

• Use tables to simplify content and data.

• Edit and proofread. Editing and proofreading can be partially automated. Look for grammar and spelling errors. Ensure consistency in style and tone.

5. Write concisely

Concise writing means using the fewest words possible to convey an idea clearly.[Grammarly]

Some examples to help you write more concisely:

• Eliminate unnecessary words such as in order to, and that. In order to is unnecessary 99% of the time. Replace it with To. For example, In order to install, would be To install.

• Replace vague words with specific ones. For example, This helps you delete the branch without removing the entire history should be X command helps you delete the branch without removing the entire history. Being specific helps you avoid confusion and misunderstandings from the reader.

• Use active voice as much as possible.

Conclusion

After reading this article, you have everything you need to become a better writer. Consider reading the following articles to learn more about writing:

• Technical Blogging VS Technical Writing: Main Differences

• How To Write A Technical Blog Post (Template)

• Why User Documentation is Essential in Software Development

Consider subscribing to my FREE weekly newsletter, I share useful content there!

Even though they share a common goal of effectively communicating with the reader and wanting to provide value, blog writing and technical writing serve two different purposes.

This blog will explain the differences between technical blogging and technical writing.

Purpose

Technical blogging aims at engaging the reader and providing valuable information in an entertaining and conversational manner.

Technical bloggers want to connect with the audience and create a sense of community. Technical bloggers adopt techniques such as descriptive language, catchy headlines, and engaging introductions. Technical bloggers tend to write content that's SEO-optimized.

Technical writing's main purpose is to convey complex information clearly and concisely.

Technical writers ensure the reader understands and can effectively use the presented information. Technical writing requires high precision and attention to detail to ensure the content is accurate, logical and easy to follow.

Technical writers also focus on usability and accessibility. They organize content to allow users to find the information they need and navigate the content effortlessly.

Read 3 Things You Can Do To Improve Your Technical Writing Skills to learn more.

Voice

Technical blogging is a style of writing that allows you to share your voice. Your writing style represents your voice and your thoughts.

In technical blogging, you use pronouns such as "you", "I", and "we". Some blog writers also use slang and swearing in their writing style to better relate and engage the user. Technical blogging tends to be more wordy compared to technical writing.

Technical writing is different. Technical writing is a sterile form of writing whose main focus is to guide the user into learning how to use a product. You use the company's voice to address the user in technical writing.

An example to show you the difference between blog writing and technical writing is this:

Technical blogging: "I recommend you use X to achieve Y".

Technical writing: "X company recommends using X to achieve Y".

Technical blogging: "Make sure you install X to view Y".

Technical writing: "Install X to view Y".

Read Top Skills To Become A Tech Blogger to learn more.

Structure

Technical blogging doesn't follow a strict structure. Often, bloggers use their voice as a style guide. Technical bloggers have a flexible and creative approach to structure and organization.

Technical bloggers can experiment with different formats like listicles, how-to guides, etc. The structure is driven by what they want to achieve with their content.

In technical writing, writers follow a well-defined style guide. The company's Head of Content (or someone senior) usually creates this style guide. Each page needs to follow a specific structure.

Technical writers follow industry-specific terminology, ensure content is organized logically and follow a step-by-step approach.

Read Why User Documentation is Essential in Software Development to learn more.

Tone

In technical blogging, the tone is informal and conversational. Technical bloggers adopt a friendly and relatable tone as if conversing with the reader.

Technical bloggers know how to convey empathy through their words, establish a connection and build trust with the audience.

In technical writing, the tone is formal and precise. The tone is objective and focused on delivering information accurately and concisely.

Technical writers prioritize clarity and avoid adding information (or words) that provide no value to the reader.

Conclusion

After reading this article, you know the difference between a tech blogger and a tech writer. Which one are you?

P.S.: if this article was helpful to you, subscribe to my FREE weekly newsletter.

Until next time!

This article will debunk the top five common misconceptions about software engineers and shed light on their abilities and responsibilities.

Let's start.

Misconception #1: Software engineers only work on coding

Coding is the core skill you need to possess to become a software engineer. Coding is how you tell the computer how to solve a problem. However, software engineering is not all about coding. Your day will also involve:

• Meeting with your colleagues, manager, and stakeholders.

• Presentations.

• Writing documentation.

• Writing tests.

• Oncall shifts.

Misconception #2: Software engineers always work on shiny new code

A lot of software engineering work is maintenance work.

Maintenance work means that you will work on adding, removing, or updating lines of code on an existing codebase.

This existing codebase is also known as legacy code. Legacy code is code someone else has written (usually employees no longer in the company), which you must take responsibility for.

Legacy code can be rewritten using better programming paradigms, and this is where software engineers provide fantastic value.

It is not an easy task.

Misconception #3: Software engineering is easy money

Unfortunately, social media has spread the idea that software engineering is easy, allowing you to make a six-figure salary relatively quickly.

This is far from the truth because:

1. It isn't easy to find entry-level jobs. Most jobs available out there are for experienced engineers.

2. Compensation depends on location, seniority level, size of the company, etc. Big Tech companies are known for paying top-of-the-market salaries. However, they do not represent the entirety of the industry in terms of compensation.

3. It takes experience, a bit of sacrifice and knowing how to negotiate to reach a specific salary.

Misconception #4: Software engineering is a solo job

Software engineering is a team sport. Teamwork is a skill that all software engineers should possess and master.

Teamwork is about asking what you can do for your team, as much as it is about asking what your team can do for you, and it’s this harmony that forms the very foundation of teamwork as we know it today. It’s about recognising how our skills and actions affect our team, as well as our own individual performance, and it’s also about adopting an attitude that leans on courage, self-love, appreciation, surrender and sacrifice.[The Benefits of Teamwork and Collaboration in Software Development]

Teamwork includes:

• Open communication.

• Having the right tools.

• Writing high-quality documentation.

Misconception #5: Software engineers can work from anywhere

In theory, yes. Software engineers only need a laptop, comfortable office equipment and reliable and fast WiFi.

However, whether a software engineer can work depends on the company and the manager. It is not a decision that a software engineer can make on his own.

Unfortunately, many companies force employees back to the office 2-3 times a week. Another consideration to make is that remote working does not necessarily mean you can work from anywhere in the world because:

• Time zones can pose a challenge to communication.

• Taxes can limit your chances of working in any country.

Misconception #6: It's a stable job

2022 and 2023 have been filled by massive layoffs, even from companies with solid performance. This has shown that software engineering (and other positions) are unsafe. You can lose your job at any time.

Conclusion

Do you agree with the misconceptions above? Let me know in the comments.

P.S.: if this article interests you, subscribe to my FREE weekly newsletter!

Related resources:

• Untold Truths About Being A Software Engineer

• How to choose a software engineering job

• How To Find Remote Tech Jobs On LinkedIn

Traversing a table in SQL

Let's examine the following SQL statements:

SELECT a, b, sum(x) from T GROUP BY a, b WHERE …;
SELECT c, d, max(y) from T GROUP BY c, d WHERE …;
SELECT a, c, avg(y), min(z) from T GROUP BY a, c WHERE …;

T represents a large table that needs to be grouped by three methods.

GROUP BY will have to traverse the T table three times. Traversing the table three times is a lengthy operation.

To reduce the amount of traversing, you could write SQL statements like this:

CREATE TABLE T_temp as SELECT a, b, c, d,
SUM(case when … then x else 0 end) sumx,
MAX(case when … then y else null end) maxy,
SUM(case when … then y else 0 end) sumy,
COUNT(case when … then 1 else null end) county,
MIN(case when … then z else null end) minz
GROUP BY a, b, c, d;
SELECT a, b, sum(sumx) from T_temp GROUP BY a,b WHERE…;
SELECT c, d, max(maxy) from T_temp GROUP BY c,d WHERE…;
SELECT a, c, sum(sumy)/sum(county), min(minz) from T_temp GROUP BY a,c WHERE …;

The SQL statements above will allow you to traverse the T table once. However, the grouping may become large, creating an even larger result.

When you have large tables (in the millions or billions of data), sorting in SQL becomes challenging.

In the following SQL statement, you will have to sort through all the data, retrieve the first five, and discard the remaining sorting results:

SELECT * FROM (SELECT x FROM T ORDER BY x DESC) WHERE rownum<=5

SQL does not support explicit set data types. In SQL, aggregate functions only return a single value, and you cannot use aggregate functions in a WHERE clause.

Sorting the top N elements in a database is a relatively straightforward operation. However, SQL operations get more challenging if you need to perform more complex operations. For example, writing a SQL statement to calculate the top N of each group after grouping is challenging:

SELECT * FROM
(SELECTy, x, row_number() over (PARTITION BY y ORDER BY x DESC) rn FROM T)
WHERE rn<=5

How open-source SPL can help

SPL stands for Structured Process Language. SPL is a programming language for structured data computing.

Open-source SPL supports more data types and operations and can solve many previously described problems. SPL enhances computing performance in a short time.

Calculate multiple groupings in one traversal

Calculate the top five by aggregate method

Retrieve the top 5 of each group

Conclusion

Open-source SPL is a powerful language that can overcome SQL's shortcomings. Read more about open-source SPL language on the official website.

Further reading

• SPL GitHub

This article describes a day in the life of a technical writer (order may vary from person to person and from day to day).

Email checking

Like many other jobs, checking emails is part of the day for a technical writer. Most of my emails come from GitHub notifications and the company's internal emails.

Pick a task

Many companies use JIRA as a project-tracking software. JIRA is where I manage all the tasks for the current or future Sprints. I look at my JIRA to plan my day and pick a high-priority task for the upcoming Sprint.

Research

My job involves writing documentation for a developer audience. I research and learn new concepts every day. I research the product, watch YouTube videos to clarify concepts, and read blogs to fulfil my curiosity.

Cross-functional collaboration

Cross-functional collaboration is a crucial part of the job of a technical writer.

Cross-functional collaboration means running a project with the help of teams from other parts of the organization.

[...]Technical writing requires a different skill set than programming—ask anyone who has read documentation written by developers. Similarly, there are few tech writers who could seamlessly take on coding tasks. Writing tasks therefore tend to be isolated from the rest of development work and remain the responsibility of writers.[Orckestra]

In my case, cross-functional collaboration happens with content designers, UX designers, software engineers, and product managers.

Write the documentation

Once you have enough information to create documentation, you start by following the company's style guide to create guides, tutorials, etc.

Submit documentation for review

Like in software engineering, before your changes reach production, they'll have to go through a review process from your peers to ensure documentation is up to standard.

Review your peers' pull requests

In software engineering, there is a code review process before your changes can be merged into production.

The exact process happens in technical writing: you support your colleagues by reviewing their pull requests so they can also carry on with their work.

Organize your JIRA

JIRA is a valuable tool. However, if not kept organized, it loses the benefits that it offers.

Organize your JIRA by:

• Giving descriptive names to your tickets. For example, include the name of the product(s).

• Adding descriptions to each ticket.

• Adding any labels.

• Adding points to each ticket.

Attend meetings

Meetings can be with SMEs (Subject Matter Experts), colleagues, and stakeholders. They can also be company-wide meetings.

Conclusion

After reading this article, you know what the day of a technical writer looks like.

Are you a technical writer? Do you agree with the article?

If this article is interesting to you, subscribe to my FREE weekly newsletter.

Related resources:

• How To Transition From Software Engineer to Technical Writer

• My First Three Months As A Technical Writer

• Why User Documentation is Essential in Software Development

What is a technical blog post?

A technical blog is written content focused on sharing knowledge and teaching the user a technical subject. Most technical focus on teaching a user how to use a technology.

How to write a technical blog post

A technical blog should have at least three main sections: an introduction, a body, and a conclusion.

Introduction

The introduction is a short paragraph under the blog post title.

The introduction is where you tell the users what you will teach them. In this section, you should tell your readers what to expect when reading the article.

Ideally, the introduction should be 3-5 sentences long.

Depending on your topic, you may want to add a "Prerequisites" section. In the prerequisites section, you tell the users what they must have installed on their laptops before they can start the tutorial.

You must add this section to ensure your readers can complete your tutorial.

Body

The body of your technical blog is where you'll dive deeper into the topic you want to cover.

Step-by-step approach

If you write tutorial-style blog posts, use a step-by-step approach for better readability.

The user should accomplish one task for each step.

For example, if you're telling the reader to "Install Node.js and write a class", you should have one step named "Install Node.js", and the following step should be "Write a class".

Use visuals

Ideally, each step should be accompanied by screenshots, code snippets, and videos. Visual content helps the reader retain more information.

Follow a logical order

If you write step-by-step tutorials, the steps must follow a logical order. Otherwise, you risk creating a negative experience for the user trying to learn a new subject.

A good example is:

• Install Java.

• Write a class.

• Create an object.

You do not:

• Write a class.

• Install Java.

• Create an object.

Conclusion

In the conclusion, you tell users what they have learned at the end of the technical blog post. In the conclusion, you can add:

• Links to your social media (GitHub included) to follow you.

• A link to your newsletter to subscribe to.

• A "Related resources" section where you share links that could help your readers.

Key Takeaways

After reading this article, you know how to write a technical blog post. This template should help you write technical blog posts faster.

If you enjoyed this article, subscribe to my FREE weekly newsletter.

Related resources:

• How To Write The Perfect Documentation For Your GitHub Project

• Why User Documentation is Essential in Software Development

• 3 Things You Can Do To Improve Your Technical Writing Skills

I started with the following:

• No readers.

• No blog posts.

• No blogging experience.

• No SEO understanding.

Two years after I've accumulated:

• 10k+ monthly readers.

• 100+ blog posts.

• A ton of blogging experience.

• Good knowledge of SEO best practices.

In this article, I'll share what I've learned in 2 years of blogging.

Let's start.

Stay consistent

"Stay consistent" will sound like a cliche, but successful blogging is more about consistency than anything else.

Staying consistent doesn't mean publishing an article daily (which I believe is unsustainable).

It means you stick to a blogging schedule that suits your needs and lifestyle.

Whether you decide to publish an article per week, every two weeks, or monthly, stay consistent with what you choose.

Blogging takes time

It took me just over 12+ months to reach 10k readers every month.

There's no overnight success when it comes to blogging.

Read How To Increase Your Blog's Traffic in 3 Easy Steps to learn how to increase your monthly traffic.

Blogging is still relevant in 2023

ChatGPT was released on the 30th of November.

When ChatGPT was launched, a lot of people believed it was going to make blogging obsolete.

This is far from the truth. Blogging has (and it will) evolved and changed.

I read a lot of online content and recognize when an article is AI-generated to manipulate the search engine.

Using automation—including AI—to generate content with the primary purpose of manipulating ranking in search results is a violation of our spam policies.[Google Search Central].

There's always so much to do

When I started my blog and had under 20 blog posts, it was easy to go back and update/delete/change content.

The more you add content to your blog, the more challenging it becomes to stay on top of the many tiny changes that make your blog better and improve SEO.

To combat this, I try to set aside some time during the week (ideally an hour) to update the most read blog posts.

Updating content means:

• Adding internal linking.

• Making sure information is still relevant.

• Adding/editing images (or visual content).

• Updating/deleting broken links.

Read Pros And Cons Of Running A Blog to learn more about the advantages and disadvantages of running a blog.

You don't always write for yourself

To grow your blog, you must write content addressing your audience's needs.

A successful blog is a blog that answers people's questions and concerns.

This means that you won't always write for yourself.

You'll have to find a balance between enjoying writing content for yourself and your audience.

Read Lessons Learned In 12 Months of Blogging

Only accept collaborations that suit your blog

Blogging brings many collaborations opportunity.

From time to time, you'll receive partnership opportunities in your inbox. However, not all partnerships are worth working with.

Your readers can sense when you want to monetize your blog, even though that means collaborating with brands that don't suit your blog.

Read Things I Wish I Knew Before Starting A Tech Blog

Treat your blog like a business

While blogging still hasn't allowed me to quit my 9-5 job, it has become a little side hustle that I treat like a business.

Ensure you have a dedicated business email for your blog. Communicate professionally with brands, whether you decide to collaborate with them or not.

Conclusion

I hope this article helps you! If it does, subscribe to my FREE weekly newsletter.

Happy blogging!

As I reflect on my path as a software engineer, I realize that with every step I took, there were valuable lessons to be learned. In this article, I will share with you lessons I wish I had known when I started.

From the importance of building a strong foundation in computer science principles to the value of continuous professional development, these insights will help aspiring software engineers navigate their career paths more effectively.

Let's start.

Picking the first job more wisely

In the first 1-2 years of your software engineering career, your priority is to learn and absorb as much as you can.

Your first software engineering is the job where you'll pick up good (and bad) habits.

In your first job, you'll learn how to read a codebase, create your first pull request, do your first code review, work as part of a team, and more.

It's where you'll form your view around best practices for software development.

Your first job may make or break your career. If you can, pick your first job wisely. But don't be discouraged by one bad job.

Don't stay in jobs where you're not growing.

Read How To Choose A Software Engineering Job to learn about the factors to consider when choosing a software engineering job.

Focusing on the basics

Every year, the tech industry creates a new framework, programming language, and database.

You don't have to learn all of them.

Focus on the basic skills that will help you in the long run, such as:

• Data structures and algorithms: these will mostly help during the interview process.

• Reading other people's code.

• Writing clean code.

Read 10 Career Advice for New Software Engineers to learn about actionable tips to succeed in your software development career.

Developing problem-solving skills

Problem-solving is the process of identifying a problem and generating potential solutions to solve a problem.

Problem-solving is the main skill of a software engineer. Companies hire software engineers to solve complex problems. You must recognize this.

Depending on the problem you're trying to solve, you may decide whether you can solve that through coding or not.

Not all problems need to be solved through coding.

You can develop and strengthen your problem-solving skills by:

• Working on projects of larger scope.

• Learn and practice different algorithms (for example, "divide-and-conquer").

• Solving mathematical problems.

• Being open to learning and unlearning.

Saving and investing

As a software engineer, your salary will increase relatively quickly.

Learn how to save, budget, invest money and avoid lifestyle inflation. You'll thank yourself in a few years.

Attending networking events

As you advance your career, networking will become more and more important. Your network will help you when you least expect it.

Attend networking events in your local area and do your best to keep those connections. They will pay off in the long run.

Read Top 5 Networking Tips For Software Engineers to learn more about how to network as a software engineer.

Embracing failure and learning from mistakes

Failure is an inevitable part of any software engineering journey. It's important to embrace failure as an opportunity for growth and learning. Instead of letting failure discourage you, use it as a stepping stone toward success.

When you encounter failure, take the time to analyze what went wrong and identify the lessons learned. Reflect on the mistakes you made and use them as valuable insights for future projects.

Don't be afraid to ask for help or seek feedback from your senior peers – this can provide a fresh perspective and help you avoid similar mistakes in the future.

Failure is not a reflection of your abilities or worth as a software engineer. It's a natural part of the learning process and an opportunity for improvement.

Embrace failure, learn from your mistakes, and keep pushing forward.

Conclusion

By the end of this article, I hope you have learned what I would have done differently if I was going to start all over again as a software engineer.

If this article is helpful to you, consider subscribing to my FREE weekly newsletter. I share more content like this.

Until next time!

Related resources:

• Tips For Your Next Pair Programming Interview

• 5 Actionable Steps to Land Your First Software Engineering Role

• Elegantly Receive Feedback As a Software Engineer

This article will describe my first three months as a technical writer.

Let's start.

Communication is key

Communication is one of a technical writer's strengths.

Communication is not just how you communicate technical information to your user.

Communication is also:

• How you communicate with members of your team.

• How you communicate with colleagues outside of your immediate team.

• How to make a request to get the desired outcome.

• How to communicate in a way that is direct and kind simultaneously.

Stakeholder management is a skill

Stakeholder management is the process of maintaining good relationships with the people who have most impact on your work.[MindTools]

A stakeholder is anyone who can be affected by the outcome of a project.

In a software project, stakeholders are usually product managers, project managers, and directors.

Stakeholder management involves:

• Identifying the strategy to communicate with stakeholders.

• Recognizing the influence a stakeholder has on a project.

• Following the stakeholder's strategy.

User experience is a skill

Everything that involves people interacting with something is a part of the user experience.[Technical Writing as a Part of User Experience]

Technical writers are critical to a product's success. As a technical writer, you must acknowledge what the users need to understand and use, document, and write about a product.

You constantly learn

Software engineers constantly learn, and so do technical writers.

Technical writers learn something new every day.

You learn the company's style guide, the company's products, the technology behind the products, etc.

Read How To Transition From Software Engineer to Technical Writer

Writing is 20% of the job

Although "writing" is part of the job title, technical writing also involves:

• Editing and proofreading.

• Project management.

• Reading and researching.

• Managing and planning meetings.

Read 3 Things You Can Do To Improve Your Technical Writing Skills

Cross-functional collaboration is part of the job

Technical writing can be perceived as a lonely job, but I find this to be far from the truth.

Technical writing involves extensive cross-functional collaboration with colleagues, engineers, product managers, and UX designers.

Technical writers seek help from various teams to produce compelling documentation.

Technical writers need multiple and different perspectives to create documentation that users will find easy to read.

Key Takeaways

My first three months as a technical writer have been full of learning. I do not regret making the transition.

Technical writing is a job that develops communication skills and teaches you how to build relationships with others.

If you enjoyed this article, subscribe to my FREE weekly newsletter. I share more content like this.

Until next time!

As the boundaries between professional and personal life blur, it's essential to prioritize your well-being and ensure a healthy and successful work-from-home (WFH) experience.

This article provides essential tips for navigating the remote era and balancing work responsibilities and personal life.

Have a routine

Everyone is different, and not everyone is routine-oriented.

However, having a routine helps increase productivity, better time management, reduce external distractions, and manage stress.

To develop a routine, identify if you're a morning or evening person, and create a routine around your preference. Understand in which part of the day you're mostly productive and focused.

Routine is a personal subject, and the best routine is the one that works for you and gets you your desired results.

Exercise

Working from home often enables people to become more physically inactive.

Exercising gives you more energy throughout the day and helps you stay in shape.

Get enough sleep

Getting enough sleep will ensure you operate at full capacity throughout the day.

Adequate sleep helps you stay focused and reduces brain fog.

What I've found helpful to have a good night's sleep is to wear earplugs and a night mask and reduce screen time 30 minutes to an hour before bed.

Some people enjoy listening to relaxing music to fall asleep.

Find your way to have a good night's sleep.

Create a dedicated workspace

Creating a dedicated workspace is crucial for maintaining focus and maximizing productivity remotely.

Without a designated area for work, it's easy to get distracted by household chores, family members, or other personal responsibilities.

Consider lighting, ergonomics, and noise levels when setting up your workspace.

Ensure you have a comfortable chair, a suitable desk, and proper lighting to minimize physical discomfort and strain.

Organize your workspace to promote efficiency and allow easy access to necessary tools and resources.

Personalize your workspace with inspiring items and create a positive work environment.

Plants, artwork, or motivational quotes can help boost your mood and well-being while working.

Invest in ergonomic equipment

Investing in ergonomic equipment makes you feel more comfortable, reduces body aches, and increases productivity.

Ergonomic equipment involves:

• A high-quality office chair.

• An ergonomic mouse.

• A laptop stand.

• A standing desk.

Take breaks every hour

It's easy to forget to take regular breaks when working from home.

Take breaks every hour. Ideally, your break would be 15/20 minutes long.

During your break, you can:

• Have a short walk.

• Do some stretching.

• Take a quick nap.

• Complete a small household chore.

• Do some meditation.

When taking a break, do an activity that doesn't involve a screen.

Have an end-of-day ritual

Having an end-of-day ritual helps you unplug from work.

Working from home can blur the lines between "work" and "life" because your work is at home and perhaps even in the same room you sleep.

Consider adding an end-of-day ritual to mark the end of the working day and the start of your time.

A ritual can be:

• Writing a to-do list for the next day.

• Playing your favourite music.

• Doing some yoga.

• Journalling.

• Listening to a podcast.

• Tidying up your desk.

• Spending time with family or a pet.

Block out time in your calendar

If you struggle with taking regular breaks and managing your time, consider using your work calendar to block time to accomplish your tasks.

Your work calendar sends you notifications and therefore helps you stay on top of your time.

In your calendar, you can block out time for:

• Regular breaks.

• Deep-work time.

• Lunch.

Have hobbies outside of work

Having hobbies outside of work helps with further achieving work-life balance.

Ideally, your hobby should be an activity that takes you outside of the house so you're not spending too much time in the same place where you work.

Sports and volunteering are great additions to your routine.

Keep your desk organized

Keeping your desk organized can give you a better sense of clarity and relaxation.

It also increases productivity because you know where you keep your items and don't have to spend time searching for them.

Change scenery

You may become reluctant to change when you have a comfortable work-from-home setup.

However, consider changing scenery from time to time.

You can work from a cafe or co-working space at a friend's house.

Anywhere you can access WiFi, and a desk/table is suitable for working.

Talk to your colleagues

Maintaining social connections and staying connected with colleagues is essential for a healthy work-life balance, especially in remote work.

Without coworkers' physical presence, finding alternative ways to foster social interactions and maintain a sense of community is essential.

Schedule regular virtual meetings or team-building activities to connect with your colleagues. This can include virtual coffee breaks, team lunches, or informal catch-up sessions.

Join online communities or professional networks related to your field of work.

Engaging with like-minded professionals can provide valuable support, advice, and networking opportunities.

These connections can help combat feelings of isolation and enhance your work-life balance.

Make an effort to reach out to colleagues for non-work-related conversations.

Building personal connections and engaging in casual conversations can help create a more inclusive and supportive remote work environment.

Visit your office

If you can, visit your office from time to time.

Visiting your office makes you feel less lonely and allows you to build relationships with people outside your team.

Final thoughts

As the remote era becomes increasingly prevalent, it's essential to prioritize work-life balance to ensure a healthy and successful work-from-home experience.

Remember, achieving work-life balance is a continuous process that requires ongoing effort and adjustment.

Experiment with different strategies and find what works best for you.

By prioritizing work-life balance, you can thrive in the remote era, enjoy the benefits of remote work, and lead a fulfilling and successful professional and personal life.

If enjoyed this article, subscribe to my FREE weekly newsletter, where I share more content like this.

Related resources:

• How To Find Remote Tech Jobs On LinkedIn

• 5 Ways To Get In The Tech Industry

• Jobs In Tech That Don't Require Coding