WORK ABOUT LAB CONTACT
contact@yellow-finger.com
02.2205.4128

Techniques for Documenting Your Web Projects

웹 프로젝트를 문서화하는 기술입니다.

Techniques for Documenting Your Web Projects
Whether working on a new web project or looking through some past ones, here are some useful tips for documenting what you've done.
새 웹 프로젝트를 수행하든, 이전 프로젝트를 살펴보든, 여기 여러분이 수행한 작업을 문서화하는 데 유용한 몇 가지 팁이 있습니다.
요약 :)
웹 사이트 구축의 깔끔한 측면 중 하나는 결국 동일한 문제에 두 번 이상 직면하게 된다는 것입니다. 이것은 다음에 무엇을 해야 할지 정확히 알 수 있음을 의미합니다. 이전에 문제를 본 적이 있는 장소와 시간을 기억하는 경우입니다.

무언가를 성취하기 위해 얼마나 많은 시간이 필요했고 완벽하게 맞는 코드를 작성했다는 것을 깨달았습니까? 그렇다면, 그 동일한 스니펫을 찾기가 거의 불가능한 경우가 얼마나 자주 있었습니까?
더보기→

출처.
Eric Karkovack . (2022.10.13). Speckyboy Design Magazine. Techniques for Documenting Your Web Projects. 2022.11.04. https://speckyboy.com/techniques-documenting-web-projects/
웹 사이트 구축의 깔끔한 측면 중 하나는 결국 동일한 문제에 두 번 이상 직면하게 된다는 것입니다. 이것은 다음에 무엇을 해야 할지 정확히 알 수 있음을 의미합니다. 이전에 문제를 본 적이 있는 장소와 시간을 기억하는 경우입니다. 무언가를 성취하기 위해 얼마나 많은 시간이 필요했고 완벽하게 맞는 코드를 작성했다는 것을 깨달았습니까? 그렇다면, 그 동일한 스니펫을 찾기가 거의 불가능한 경우가 얼마나 자주 있었습니까? 이것은 웹 디자이너에게 공통적인 과제입니다. 그렇기 때문에 몇 가지 기본적인 프로젝트 문서를 작성하는 것이 도움이 될 수 있습니다. 이러한 시스템을 배치하면 시간을 절약할 수 있는 스니펫을 쉽게 찾을 수 있습니다. 새 프로젝트를 진행 중이든 과거 프로젝트를 살펴보고 있든 수행한 작업을 문서화하기 위한 몇 가지 팁이 있습니다. 웹 디자이너 도구 상자 무제한 다운로드: HTML 및 부트스트랩 템플릿, WordPress 테마 및 플러그인, 그리고 훨씬 더! HTML 템플릿 HTML 템플릿 3,200개 이상의 템플릿 부트스트랩 템플릿 부트스트랩 템플릿 2,000개 이상의 템플릿 관리 템플릿 대시보드 템플릿 240개 이상의 템플릿 워드프레스 테마 워드프레스 테마 1,450개 이상의 테마 이메일 템플릿 뉴스레터 템플릿 270개 이상의 템플릿 웹 글꼴 웹 글꼴 13,500개 이상의 글꼴 지금 다운로드를 시작하세요! 코드에 주석 달기 이것은 약간 명백한 것처럼 보이지만 덜 중요하지는 않습니다. 코드를 작성할 때 정확히 무엇을 하는지에 대한 적절한 주석을 추가하는 것이 좋습니다. 일반적인 관행에는 목적과 관련성을 설명하기 위해 각각의 새로운 기능 위에 짧은 설명을 작성하는 것이 포함됩니다. 그 외에도 해당 기능 내의 다른 주요 위치에 메모를 추가하면 우리(및 다른 사람들이 우리의 코드를 검토하는 경우)가 모든 것이 어떻게 구성되어 있는지 더 잘 이해할 수 있습니다. 그리고 이 방법은 PHP나 JavaScript와 같은 복잡한 언어에만 해당되는 것은 아닙니다. CSS에도 적합합니다. 특정 스타일과 사용 위치를 지적하는 것은 필요한 것을 정확히 찾는 데 좋습니다. 종종 전투의 절반이 각 라인이 있는 이유와 수행해야 하는 작업을 기억하는 것 같습니다. 댓글을 작성하면 이러한 모호성을 많이 없앨 수 있습니다. 코드의 주요 부분에 주석을 추가하면 편리한 참조가 됩니다. 각 프로젝트에 대한 저널 만들기 당신의 성격에 따라 "저널"이라는 단어에 대한 언급은 믿을 수 없을 정도로 무섭거나 이상하게 위로가 될 수 있습니다. 어느 쪽이든, 연습에는 큰 가치가 있습니다. 이 경우 미래의 프로젝트 리소스 역할을 하는 문서에 대해 이야기하고 있습니다. 웹 사이트가 중단되거나 새로운 기능이 필요한 경우 구성 방법에 대한 세부 정보를 참조할 수 있는 곳입니다. 워드 프로세싱 문서를 열거나 모두 나가서 로컬 설치 에 Wiki를 만드십시오 . 원하는 만큼 상세하게(또는 그렇지 않을 수) 있습니다. 여기에는 엄격하고 빠른 규칙이 없습니다. 예를 들어, 우리의 설계 및 개발 기술은 발전하는 경향이 있습니다. 몇 년 전에 취한 접근 방식은 현재 하고 있는 것과 다를 수 있습니다. 따라서 프로세스의 다양한 요소를 글로 작성하는 것이 중요합니다. 또한 공통 시스템과 라이브러리를 사용하는 경우에도 각 웹 사이트는 별도의 개체입니다. 어디서부터 시작해야 할지 모르겠다고요? 사이트가 다른 사이트와 다른 점을 살펴보십시오. 생성한 특수 템플릿, 특정 코드 조각 또는 스타일을 기록해 둡니다. 고유한 서버 구성을 설정하는 경우 문서화하는 것도 좋습니다. 프로젝트 일지를 작성하면 작은 세부 사항을 기억하는 데 도움이 됩니다. 코드 조각 라이브러리 유지 관리 코드와 관련하여 바퀴를 재발명할 필요가 없습니다. 우리가 쓰는 것의 대부분은 무한히 재사용할 수 있습니다. 새 프로젝트의 요구 사항에 완전히 맞지 않더라도 올바른 스니펫은 추가 사용자 지정을 위한 확실한 출발점이 될 수 있습니다. 그러나 서로 다른 코드 비트를 구성하는 것은 어려울 수 있습니다. 유용한 부분을 복사하여 문서에 붙여넣고 필요에 따라 검색할 수 있습니다. 그러나 많은 코드 를 작성하는 사람들에게는 이것이 다소 빨리 손에 잡히지 않을 수 있습니다. GitHub 리포지토리가 합리적인 솔루션이 될 수 있습니다. 이를 통해 사물을 분류하고 버전 관리를 설정할 수 있습니다. 저장소를 다른 서비스와 동기화하여 다른 방식으로 사용하거나 액세스할 수도 있습니다. 스니펫 라이브러리를 함께 배치하는 방법에 관계없이 각 스니펫에 태그를 지정하거나 분류하거나 레이블을 지정하기 위한 일종의 시스템을 개발하고 싶을 것입니다. 예를 들어 사용된 코딩 언어, 목적, 관련 애플리케이션(예: WordPress) 또는 라이브러리(React, Vue, Bootstrap )와 같은 항목을 추가할 수 있습니다. 이렇게 하면 필요한 프로세스를 훨씬 더 원활하게 찾을 수 있습니다. 코드 조각 저장소를 사용하면 일반적으로 사용되는 항목을 쉽게 찾을 수 있습니다. 작업 백과사전 웹 디자이너 는 자신의 작업을 과시 할 포트폴리오 를 만드는 것을 좋아합니다 . 그러나 내부적으로 프로젝트를 추적하는 것도 가치 있는 노력입니다. 문제를 해결하고 기존 웹 사이트를 기반으로 구축하는 동시에 새로운 웹 사이트에 대한 솔루션도 제공할 수 있습니다. 위의 기술 중 일부 또는 전부를 사용하여 정리할 수 있습니다. 가장 좋은 점은 원하는 대로 사용자 정의할 수 있다는 것입니다. 그것이 탐욕스러운 메모를 통해서든 간단한 알림을 통해서든 웹 프로젝트의 무엇을, 어디서, 언제, 왜 더 잘 이해하는 데 도움이 될 것입니다.