Các nhà phát triển phần mềm, tại sao bạn vẫn chưa bắt đầu viết kỹ thuật?

Blog là một phần hữu ích vì nhiều lý do không chỉ với bạn mà còn với các nhà phát triển phần mềm công nghệ khác.

Viết kỹ thuật giúp nhà phát triển phần mềm chia sẻ kiến thức/kinh nghiệm kỹ thuật của họ với các nhà phát triển phần mềm khác trong lĩnh vực công nghệ phần mềm.

Viết kỹ thuật là một môn viết liên quan đến việc truyền đạt thông tin phức tạp tới những người cần nó để thực hiện một nhiệm vụ nhất định hoặc đạt được một mục tiêu nhất định. Vì điều này, văn bản kỹ thuật thường được định nghĩa là “ đơn giản hóa sự phức tạp ”.

Nó cũng nâng cao hiểu biết của bạn về chủ đề bạn đang viết và thể hiện rõ ràng chuyên môn kỹ thuật của bạn.

Điều độc đáo nhất về viết kỹ thuật không chỉ là bạn có thể tạo ra những cơ hội tuyệt vời trong tương lai (một công việc từ xa trong lĩnh vực công nghệ, một hợp đồng viết bài tự do hoặc cơ hội đăng bài cho khách tại một trang web của công ty công nghệ lớn, v.v.), mà nó còn có thể giúp bạn xây dựng sự hiện diện trực tuyến mà cuối cùng sẽ giúp ích cho bạn trong sự nghiệp trở thành nhà phát triển phần mềm.

Đôi khi, tôi quay lại và đọc các bài đăng trên blog của mình khi tìm kiếm thông tin về một chủ đề cụ thể.

Nếu bạn đã làm được điều gì đó thú vị trong sự nghiệp kỹ sư phần mềm của mình nhưng lại giữ nó cho riêng mình thì bạn đang bỏ lỡ một cơ hội lớn.

Bắt đầu viết và đó là một cách hiệu quả để quảng bá ý tưởng của bạn trên internet.

“Viết blog mà bạn ước mình tìm thấy khi… https://t.co/PcXR0fL9QF

- Ankur💻🎧💪 (@TheAnkurTyagi) Ngày 3 tháng 10 năm 2023

Ngoài ra, nếu bạn thích giúp đỡ người khác học hỏi, thích tham gia các dự án nguồn mở và chỉ cho người khác cách tham gia hoặc cảm thấy hài lòng khi giải thích những ý tưởng phức tạp theo những cách dễ hiểu thông qua bài viết của mình, thì viết kỹ thuật rất phù hợp với bạn. Bạn.

Trong bài viết này, tôi nhằm mục đích giải thích cách lập trình và viết có thể hợp nhất để nâng cao kỹ năng nhà phát triển của chúng tôi. Vâng, viết! Tôi thực sự nghĩ rằng tất cả chúng ta đều có khả năng viết ở một mức độ nào đó. Tôi ở đây để cung cấp cho bạn các mẹo viết, lời khuyên và ví dụ để giúp bạn trở thành nhà phát triển và người giao tiếp thành thạo hơn.

Viết kỹ thuật là gì

Viết kỹ thuật là đưa ra các hướng dẫn rõ ràng và chi tiết để giúp người dùng, nhà phát triển đồng nghiệp hoặc người quản lý giúp họ hiểu một sản phẩm kỹ thuật, kỹ năng hoặc ý tưởng kỹ thuật.

Người viết kỹ thuật là người tạo ra các hướng dẫn và tài liệu kỹ thuật này.

Viết kỹ thuật có thể là:

• Hướng dẫn sử dụng hoặc tích hợp giữa hai SaaS kỹ thuật
• Bài viết hỗ trợ trực tuyến
• Báo cáo kỹ thuật trình bày thông tin về một chủ đề cụ thể, thường là sau khi tiến hành nghiên cứu hoặc thử nghiệm. Chúng phổ biến trong các lĩnh vực khoa học và kỹ thuật.
• Đề xuất kỹ thuật , Những tài liệu này phác thảo một kế hoạch, ý tưởng hoặc dự án một cách rõ ràng và thuyết phục. Chúng được sử dụng để tìm kiếm sự chấp thuận, tài trợ hoặc hợp tác.
• Siêu vật liệu nội bộ dành cho lập trình viên và tài liệu API dành cho nhà phát triển.

Về bản chất, người viết kỹ thuật truyền tải các chi tiết kỹ thuật theo cách cho phép người đọc áp dụng hiệu quả thông tin đó cho một mục đích cụ thể.

Nếu bạn đang bắt đầu viết về kỹ thuật và cố gắng viết về phát triển/lập trình phần mềm hoặc những gì bạn đã học được về công nghệ, nhưng vẫn chưa viết blog đầu tiên của mình, bạn sẽ tìm thấy giá trị lớn nhất trong hai phần đầu tiên của cuốn sách. bài đăng blog này nơi tôi nói về cách bắt đầu với tư cách là một nhà văn hoặc blogger kỹ thuật và cách mở rộng quy mô blog của bạn.

Phần còn lại của blog, bạn sẽ thấy hữu ích trong việc bổ sung mọi lỗ hổng kiến thức mà bạn cần để thành công với tư cách là nhà phát triển phần mềm và phát triển mạnh ở nơi làm việc cũng như thăng tiến trong sự nghiệp của mình.

“Nếu bạn có ước mơ, bạn có thể dành cả đời để học tập, lập kế hoạch và sẵn sàng cho nó. Những gì bạn nên làm là bắt đầu.”

—Drew Houston

Viết ở mọi nơi?

Hai tài nguyên trực tuyến hàng đầu mà mọi người sử dụng để học viết mã là tài liệu kỹ thuật và Stack Overflow, trong đó các blog nằm trong top ba.

Ba yếu tố giúp mọi người tự học về công nghệ bao gồm tài liệu rõ ràng, cộng đồng sôi động cung cấp giải pháp và bài đăng thường xuyên.

Các nhà phát triển đánh giá cao nhiều nguồn bổ sung, bao gồm video hướng dẫn, bài viết hướng dẫn, sách và diễn đàn – họ tập hợp các nguồn và định dạng phù hợp nhất với phong cách học tập của họ.

Có thể trình bày ý tưởng của bạn một cách rõ ràng trong nhóm và trực tuyến là một kỹ năng có giá trị, vì nhiều nhà phát triển cảm thấy đây là một thách thức. Chỉ cần nghĩ xem bạn viết bao nhiêu bài mỗi ngày mà không liên quan đến việc viết mã. Kỹ năng này là một siêu năng lực.

Bạn tham gia vào nhiều hình thức viết khác nhau như trò chuyện Slack, email, tài liệu dành cho nhà phát triển nội bộ, bản nháp RCA, readme, nhận xét mã, thông báo cam kết Git, yêu cầu kéo, nhận xét đánh giá mã, phản hồi hiệu suất hàng năm, ghi chú cuộc họp, v.v.

Nắm vững cách viết là rất quan trọng đối với các nhà phát triển phần mềm. Kỹ năng viết không đầy đủ có thể cản trở sự thăng tiến nghề nghiệp của họ ở một mức độ nhất định. Nhiều kỹ sư sau này trong sự nghiệp của họ nhận ra rằng “kỹ năng mềm cũng quan trọng như viết mã”.

Các bạn trẻ: Sự nghiệp kỹ sư phần mềm của bạn sẽ cải thiện đáng kể và bạn sẽ có được những cơ hội tốt hơn trong tương lai trong lĩnh vực công nghệ nếu bạn bắt đầu viết 30 phút mỗi ngày và đăng 2-3 blog trực tuyến mỗi tháng, nhưng rất ít nhà phát triển thực sự có thể làm được điều này trong thời gian dài. lâu dài. https://t.co/damIJ5gXys

- Ankur💻🎧💪 (@TheAnkurTyagi) Ngày 4 tháng 10 năm 2023

Tại sao viết lại quan trọng đối với các nhà phát triển

JavaScript, TypeScript, PHP, Go, Java - có rất nhiều ngôn ngữ lập trình khác nhau và thậm chí bạn có thể thông thạo nhiều ngôn ngữ đó.

Khi chúng ta cố gắng tạo ra mã chất lượng cao hơn trong sự nghiệp công nghệ của mình, khả năng viết và giao tiếp hiệu quả bằng ngôn ngữ hàng ngày sẽ trở thành một kỹ năng quan trọng, một kỹ năng có thể bị đánh giá thấp trong lĩnh vực công nghệ phần mềm.

Công nghệ phần mềm không chỉ là về mã. Đó là về con người + mã.

Làm thế nào tôi trở thành một nhà văn giỏi hơn với tư cách là một kỹ sư phần mềm

Cách các kỹ sư trình bày suy nghĩ của họ về mã có thể cũng quan trọng như chính mã đó. Bất kể lập trường của bạn về vấn đề này như thế nào, chúng tôi có thể nhất trí thừa nhận rằng lời nói của chúng tôi có khả năng nâng cao hoặc cản trở tính hiệu quả của quy tắc.

Viết có thể giúp bạn tăng diện tích bề mặt may mắn của mình.

L = D * T, trong đó L là may mắn, D đang làm và T đang kể.

– Jason C. Roberts

6 lợi ích chính của việc viết kỹ thuật

Nó giúp bạn hiểu các khái niệm ở mức độ sâu hơn.

• Bạn cần nghiên cứu các khái niệm mà bạn đang giải thích, điều này giúp bạn tiếp cận được những ý tưởng, ứng dụng và vấn đề khác nhau.

• Các khái niệm sẽ in sâu vào não bạn hơn khi bạn giải thích chúng cho người khác.

• Bằng cách cấu trúc và trình bày thông tin cho người khác, bạn thường phát hiện ra những lỗ hổng kiến thức của mình. Nhờ đó, nó cũng giúp bạn tiến bộ nhanh hơn trong sự nghiệp dev của mình.

• Người viết kỹ thuật là những người học suốt đời vì với mỗi blog kỹ thuật mới, bạn nghiên cứu và viết, bạn sẽ trở thành chuyên gia về chủ đề đó.

• Viết cũng thúc đẩy sự hiểu biết sâu sắc hơn về sự đồng cảm của người dùng. Nó nhắc bạn tập trung nhiều hơn vào quan điểm và cảm xúc của người đọc hoặc người dùng sản phẩm, thay vì chỉ dựa vào quan điểm của bạn.

  
  

• Dưới đây là một số lợi ích bổ sung:

Hơn nữa, bạn có thể tạo thu nhập với tư cách là người viết kỹ thuật bằng cách đóng góp cho nhiều tổ chức khác nhau. Hãy xem những Người viết-Kỹ thuật-Trả tiền cho Công ty Tuyệt vời này.

Ở trường đại học, tôi học bằng cách dạy kèm những người khác trong ký túc xá

Giải thích điều gì đó, hoặc thậm chí giả vờ, buộc bạn phải sắp xếp kiến thức của mình một cách mạch lạc, bộc lộ những lỗ hổng kiến thức và củng cố những phần bạn biết.

Cách tốt nhất để học là dạy và viết là tài sản tuyệt vời cho mọi nhà phát triển.

Thay vì chỉ chú ý, mọi người và doanh nghiệp đều đáp lại bạn. Khi bạn viết một bài blog kỹ thuật, bạn sẽ nhận được phản hồi ngay lập tức. Bài viết kỹ thuật của bạn cũng hỗ trợ việc truyền bá, mở ra những cơ hội hấp dẫn hơn nữa.

Ngoài ra còn có một nghề nghiệp sinh lợi trong lĩnh vực viết lách kỹ thuật nếu bạn thấy mình thích nó và Hầu hết mọi thứ tôi viết trên blog của mình ngày nay đều là những khái niệm mà tôi đang cố gắng hiểu rõ hơn. Nếu tôi không thể giải thích nó bằng văn bản thì tôi chưa hiểu rõ về nó.

Các ví dụ về văn bản kỹ thuật là gì?

Với tư cách là người viết kỹ thuật, vai trò của bạn liên quan đến việc dịch thông tin kỹ thuật phức tạp sang ngôn ngữ dễ tiếp cận và thân thiện với người dùng. Viết kỹ thuật bao gồm nhiều hình thức khác nhau, bao gồm tạo hướng dẫn từng bước và hướng dẫn toàn diện.

Mục tiêu chính là tạo điều kiện thuận lợi cho sự hiểu biết về mọi khía cạnh kỹ thuật của sản phẩm hoặc dịch vụ, cho dù giữa các thành viên nội bộ trong nhóm hay người dùng cuối.

Với ý nghĩ đó, các ví dụ về văn bản kỹ thuật sau đây sẽ giúp bạn hiểu rõ hơn.

1. Đánh giá SuperTokens– một giải pháp thay thế nguồn mở cho Auth0, Firebase Auth và AWS Cognito.

Đây là một ví dụ rất đơn giản về việc đánh giá siêu mã thông báo và lý do tại sao “siêu mã thông báo” có khả năng xác thực người dùng tốt.

2. Cách sử dụng Medusa để tạo cửa hàng thương mại điện tử Next.js

Đây là một ví dụ rất hay về cách bạn có thể xây dựng một hướng dẫn cùng với việc xây dựng một ứng dụng. Trong blog này, tôi đã chia sẻ hướng dẫn từng bước để xây dựng cửa hàng thương mại điện tử của Medusa, một giải pháp nguồn mở thay thế cho Shopify.

3. Cách triển khai LLM với MindsDB và OpenAI

Trong hướng dẫn này, tôi đã chia sẻ cách bạn có thể triển khai LLM với MindDB và OpenAI

4. Cách di chuyển cơ sở dữ liệu của bạn từ Supabase sang HarperDB

Hướng dẫn đầy đủ về cách bạn có thể di chuyển cơ sở dữ liệu của mình từ Supabase sang HarperDB

5- Tài liệu sản phẩm

Tài liệu sản phẩm bao gồm các hướng dẫn về cách sử dụng và tích hợp hiệu quả với các công cụ dành cho nhà phát triển khác.

Viết tài liệu sản phẩm đòi hỏi kỹ năng viết kỹ thuật tốt và kiến thức tổ chức. Đây chỉ là một vài ví dụ về viết kỹ thuật đòi hỏi kỹ năng nghiên cứu, hình dung cao và khả năng kết nối với nhiều đối tượng khác nhau.

Mẹo- “Hãy tự hỏi bản thân, 'Tiêu đề có thu hút sự quan tâm của người đọc không?' Nếu đúng như vậy, họ có thể sẽ đi sâu vào phần giới thiệu và sau đó quyết định, 'Có đáng để tôi đầu tư thời gian vào toàn bộ tác phẩm này không?' Một lỗi phổ biến mà tôi thường quan sát thấy trong các bài viết kỹ thuật là giới thiệu quá nhiều hoặc ngược lại, quá ít.

Một đoạn văn được soạn thảo chính xác có thể tạo tiền đề một cách hiệu quả cho một bài đăng blog kỹ thuật.

Làm cách nào để tôi bắt đầu với tư cách là người viết kỹ thuật

Cho đến nay, câu hỏi phổ biến nhất mà tôi nhận được về “Viết blog hoặc viết blog kỹ thuật” là về cách bắt đầu.

Trong cuộc sống, có vẻ như trở ngại lớn nhất để làm điều gì đó và trở thành người mà bạn mong muốn chính là việc bắt đầu.

Kẻ thù tồi tệ nhất là “sự nghi ngờ bản thân”. pic.twitter.com/fw1691QRSY

- Ankur💻🎧💪 (@TheAnkurTyagi) Ngày 10 tháng 8 năm 2023

Cho dù đó là bắt đầu một chế độ tập luyện mới, luyện tập chạy marathon, khởi nghiệp, viết sách hay cụ thể hơn là trong trường hợp này là viết lách, phần khó nhất luôn là bắt đầu.

Thật dễ dàng—và đầy cám dỗ—lãng phí vô số thời gian để tranh luận xem bạn nên làm gì.

Việc “đọc”, “đọc” và “nghiên cứu” dễ dàng hơn nhiều so với việc bắt đầu “viết”.

Tuy nhiên, bí mật là bạn chỉ cần thực hiện từng bước một.

Xây dựng ít nhất một tài sản kép trong sự nghiệp kỹ sư phần mềm của bạn

– Bắt đầu một blog– Bắt đầu một bản tin– Bắt đầu quay video YT– Bắt đầu một podcast– Bắt đầu xây dựng mạng lưới

Xây dựng, xuất bản và lặp lại

Những cơ hội trong tương lai đang chờ đợi bạn trên internet

Cc @TheAnkurTyagi

- Kap.ts (@Kaperskyguru) Ngày 17 tháng 2 năm 2023

Và nhìn xung quanh; hầu hết các nhà phát triển trong lĩnh vực công nghệ phần mềm không viết mã 24/7; hầu hết chúng ta dành nhiều thời gian để làm những việc khác mỗi ngày.

Điều đó bao gồm:

• Trình diễn một chức năng mới cho toàn nhóm trong công ty hoặc khách hàng.
• Ghi lại một tính năng mới hoặc cũ trong sản phẩm của bạn.
• Cập nhật một vé liên quan đến JIRA.
• Tạo công việc tồn đọng để hỗ trợ tính năng mới đó.

Tất nhiên, luôn có thời gian để đi vệ sinh/nghỉ trưa và lướt Twitter 😉

vì vậy đừng suy nghĩ quá nhiều- hãy bắt đầu

“Viết giống như học chơi bóng rổ.”

– David Perell

Để trở thành một nhà văn thành công và tìm được cơ hội, bạn phải có 3 kỹ năng.

• Mã hóa
• Viết
• Tiếng Anh

Có, Trước khi bắt đầu viết, trước tiên bạn phải hiểu tiếng Anh, bao gồm các thì, chính tả và ngữ pháp cơ bản.

Độc giả của bạn không muốn đọc một bài viết có nhiều lỗi ngữ pháp và lựa chọn từ ngữ kém.

Trong ngành công nghệ, tiếng Anh đã trở thành ngôn ngữ giao tiếp thực tế giữa các nhà phát triển phần mềm, kỹ sư và các chuyên gia công nghệ khác trên toàn thế giới. Đó là ngôn ngữ được sử dụng cho tài liệu, ngôn ngữ lập trình và các công cụ được sử dụng để phát triển.

Học cách truyền đạt ý tưởng một cách đơn giản và rõ ràng

Biết cách triển khai một tính năng kỹ thuật không nhất thiết có nghĩa là bạn có thể giải thích quy trình đó cho người khác.

Trở thành một giáo viên giỏi đòi hỏi sự đồng cảm và kỹ năng truyền đạt thông tin theo cách phù hợp với đối tượng mục tiêu của bạn

Bạn sẽ không hiểu điều gì đó nếu bạn không thể giải thích nó cho một đứa trẻ sáu tuổi.

Einstein, Albert

Không có một chiến lược hoàn hảo nào để trở thành một nhà văn xuất sắc. Vậy thì bạn có thể thắc mắc tại sao tôi lại thảo luận về chủ đề này. Bởi vì điều quan trọng là phải giải quyết vấn đề này ngay từ đầu.

“Đừng tìm kiếm một chiến lược; hãy tìm kiếm tiếng nói độc đáo của bạn trong văn bản và xây dựng phong cách của bạn.”

Cách viết duy nhất bạn nên biết.

• Ít công nghệ hơn là nhiều hơn, tôi làm việc với React 90% thời gian.

• Nếu bạn viết lần đầu tiên, hãy cho bản thân thêm thời gian để tìm hiểu.

• Cho phép bản thân viết kém.

• Hãy ngừng chuẩn bị và bắt đầu hành động.

  
  

Làm thế nào để trở thành một nhà văn nổi bật trong kỷ nguyên AI:

Trước khi viết bài đăng blog tiếp theo của bạn, hãy yêu cầu ChatGPT viết một bài về chủ đề này và cho bạn thấy những nội dung chung chung nào đã có sẵn trên internet để bạn có thể tránh nói điều đó và chỉ viết những gì quan trọng và độc đáo đối với khán giả.

- Ankur💻🎧💪 (@TheAnkurTyagi) Ngày 16 tháng 2 năm 2023

Để hiểu khán giả của bạn, hãy hỏi những câu hỏi này trước khi bạn bắt đầu viết.

• Độc giả của bạn là ai?
• Họ tìm kiếm gì trên Google hoặc họ đang gặp phải vấn đề gì?
• Những blog họ đang đọc hiện nay?
• Họ sẽ đọc như thế nào?

Làm thế nào để nảy ra ý tưởng cho bài đăng trên blog

• Viết bài báo có thể khiến bạn không phải dành hàng giờ để tìm kiếm trên Google và gãi đầu.

• Bất cứ khi nào bạn học được điều gì đó mới, hãy viết về cách bạn đã học được điều đó và những gì bạn đã học được.

• Viết một câu chuyện về lĩnh vực, sở thích hoặc nghề nghiệp của bạn.

• Chọn một bài đăng blog từ blogger yêu thích của bạn mà bạn thấy thú vị và khám phá cùng một chủ đề từ một góc nhìn mới mẻ hoặc giải quyết một chủ đề khác từ một góc độ tương tự.

  
  

Viết bài đăng trên blog mà bạn ước mình đã tìm thấy khi tìm kiếm thứ gì đó trên Google.

- Ankur💻🎧💪 (@TheAnkurTyagi) Ngày 20 tháng 3 năm 2023

Lưu ý- Nếu bạn đã làm được điều gì đó thú vị trong sự nghiệp kỹ sư phần mềm của mình nhưng lại giữ nó cho riêng mình thì bạn đang bỏ lỡ một cơ hội lớn.

Internet được điều hướng tốt nhất thông qua việc viết khi muốn quảng bá ý tưởng của bạn một cách hiệu quả.

Có một điểm tuyệt vời để viết các bài đăng và hướng dẫn kỹ thuật. Viết cho những người chuyên nghiệp chưa có thời gian để tìm hiểu điều đó và liên kết nó với những điều họ đã biết. Ví dụ: giải thích một kỹ thuật JS hiện đại cho người biết jQuery.

– Rachel Andrew (@rachelandrew) Ngày 20 tháng 2 năm 2019

Phần kết luận

Viết là một công việc dễ dàng đối với hầu hết các nhà phát triển lành nghề.

Nếu bạn nghĩ rằng bạn có thể học được nhiều điều về công nghệ từ việc đọc một bài đăng trên blog; hãy thử viết một bài trong tuần này.

- Ankur💻🎧💪 (@TheAnkurTyagi) Ngày 2 tháng 10 năm 2023

Lý do mà mọi nhà phát triển nên viết một bài blog về những gì họ học được trong công nghệ phần mềm là vì việc viết lách khiến họ phát hiện ra rằng có lẽ họ không hiểu rõ điều gì đó như họ nghĩ.

Dạy và viết về bất cứ điều gì là cách tốt nhất để tìm hiểu về nó, và đó là điều dễ dàng để bạn bắt đầu một lối sống mới bởi vì bạn đã có kinh nghiệm trực tiếp, vì vậy tất cả những gì bạn phải làm là xuất hiện, viết một bài đăng trên blog. năm nay và đánh giá kết quả, đồng thời lên kế hoạch cho bước đi tiếp theo của bạn!

“Đọc để thu thập các dấu chấm, viết để kết nối chúng.” – David Perell

Điểm mấu chốt là việc mài giũa kỹ năng viết của bạn và nỗ lực thêm một chút trong bài viết của bạn có thể thực sự nâng cao khả năng của bạn với tư cách là một nhà phát triển. Bạn có thể thấy những mẹo này hữu ích khi cộng tác với các nhà phát triển khác, duy trì công việc của mình, tạo nội dung khi cần hoặc thậm chí soạn thảo đề xuất dự án, cùng nhiều nhiệm vụ khác.

Tài nguyên viết kỹ thuật

• Lời khuyên dành cho Viết kỹ thuật (Một bài đăng blog được viết rất hay của Chris từ CSS Tricks)
• Tài nguyên viết kỹ thuật (Repo GitHub của Cynthia Peter )
• Hướng dẫn viết kỹ thuật của Google
• Viết kỹ thuật cơ bản
• Viết tài liệu